spectre.Pipelines.Bbh.Cce

Functions

run_cce(bondi_sachs_data[, force, ...])

Extract partial or full waveforms from a simulation.
spectre.Pipelines.Bbh.Cce.run_cce(bondi_sachs_data: str | Path | Sequence[str | Path], force: bool = False, cce_input_file_template: str | Path = CCE_INPUT_FILE_TEMPLATE, lev: int | None = None, pipeline_dir: str | Path | None = None, run_dir: str | Path | None = None, segments_dir: str | Path | None = None, **scheduler_kwargs)

Extract partial or full waveforms from a simulation.

Pass the files containing Bondi-Sachs data as the first argument. It can be a single file, or multiple files that will be combined before running CCE (e.g. from multiple segments across inspiral/ringdown). Here, it’s important that the filename of the BondiSachs data is in the form NameOfFileRXXXX.h5, with the last 4 characters being the wave extraction radius. The remaining options are forwarded to the ‘schedule’ command. See ‘schedule’ docs for details.

Parameters:

  • bondi_sachs_data – Path to one or more files containing Bondi-Sachs data

  • lev – Resolution of the simulation that the waveforms are extracted from. Required when running in a ‘pipeline_dir’, because it determines the directory that CCE runs in.

  • pipeline_dir – Directory of the simulation, in which the pipeline creates its runs.

  • run_dir – Directory where the CCE executable is run. Mutually exclusive with ‘pipeline_dir’.

  • segments_dir – Directory in which the CCE run is created. Mutually exclusive with ‘pipeline_dir’ and ‘run_dir’.

  • cce_input_file_template – Input file template for CCE. This should be a yaml file that defines the steps in the CCE pipeline.