nrcats.classification

Dynamic threshold-based classification and organization of numerical relativity catalogs.

Exposes the NRCatalogClassifier class which categorises simulations in SXS, RIT, and MAYA catalogs into six mutually exclusive categories based on spin and eccentricity thresholds, and supports filtering by NRSur7dq4 training simulations.

Contents

  1. nrcats.classification
    1. class NRCatalogClassifier
      1. load_catalog
        1. Parameters
        2. Returns
      2. load_nrsur_calibration_sims
        1. Returns
      3. classify_simulation
        1. Parameters
        2. Returns
      4. classify_all
        1. Parameters
      5. get_simulations
        1. Parameters
        2. Returns

class NRCatalogClassifier

Classifies simulations in SXS, RIT, and MAYA catalogs based on spin and eccentricity thresholds.

Provides methods to query simulations belonging to different physical categories dynamically.

load_catalog 

load_catalog(catalog_name: str)

Lazy load a catalog by name tag.

Parameters

Name Type Description
catalog_name str One of ‘SXS’, ‘RIT’, ‘MAYA’ (case-insensitive).

Returns

Name Type Description
  CatalogBase subclass  

load_nrsur_calibration_sims 

load_nrsur_calibration_sims() -> set[str]

Load and return the set of SXS simulations used to train/calibrate NRSur7dq4.

Extracts the calibration set from catalog_organization/sxs_classification.json.

Returns

Name Type Description
  set[str] Simulation name tags (e.g. ‘SXS:BBH:0001’).

classify_simulation 

classify_simulation(catalog_name: str, sim_name: str) -> str

Classify a single simulation into one of the six categories.

Parameters

Name Type Description
catalog_name str One of ‘SXS’, ‘RIT’, ‘MAYA’.
sim_name str Name tag of the simulation.

Returns

Name Type Description
  str Category name.

classify_all 

classify_all(catalog_name: str)

Precompute and cache classifications for all simulations in a catalog.

Parameters

Name Type Description
catalog_name str One of ‘SXS’, ‘RIT’, ‘MAYA’.

get_simulations 

get_simulations(catalog_name: str, category: str, only_nrsur_calibration: bool = False) -> list[str]

Get the list of simulation name tags under a given catalog and category.

Parameters

Name Type Description
catalog_name str One of ‘SXS’, ‘RIT’, ‘MAYA’ (case-insensitive).
category str One of ‘a’, ‘b’, ‘c’, ‘d’, ‘e’, ‘f’ or their full name values.
only_nrsur_calibration bool If True, only returns simulations used to calibrate NRSur7dq4 (SXS only).

Returns

Name Type Description
  list[str] Simulation name tags matching the category.