spectre.Pipelines.Bbh.Ringdown

Functions

ringdown_parameters(inspiral_input_file, ...)

Determine ringdown parameters from the inspiral.

start_ringdown(inspiral_run_dir, ...[, ...])

Schedule a ringdown simulation from the inspiral.
spectre.Pipelines.Bbh.Ringdown.ringdown_parameters(inspiral_input_file: dict, inspiral_run_dir: str | Path, fot_vol_subfile: str, refinement_level: int, polynomial_order: int) → dict

Determine ringdown parameters from the inspiral.

These parameters fill the ‘RINGDOWN_INPUT_FILE_TEMPLATE’.

Parameters:

  • inspiral_input_file – Inspiral input file as a dictionary.

  • id_run_dir – Directory of the inspiral run. Paths in the input file are relative to this directory.

  • fot_vol_subfile – Subfile in volume data used for Functions of Time.

  • refinement_level – h-refinement level.

  • polynomial_order – p-refinement level.

spectre.Pipelines.Bbh.Ringdown.start_ringdown(inspiral_run_dir: str | Path, number_of_ahc_finds_for_fit: int, match_time: float, settling_timescale: float, zero_coefs_eps: float, refinement_level: int, polynomial_order: int, inspiral_input_file: str | Path | None = None, ahc_reductions_path: str | Path | None = None, ahc_subfile: str = 'ObservationAhC_Ylm', fot_vol_h5_path: str | Path | None = None, fot_vol_subfile: str = 'ForContinuation', path_to_output_h5: str | Path | None = None, output_subfile_prefix: str = 'Distorted', ringdown_input_file_template: str | Path = RINGDOWN_INPUT_FILE_TEMPLATE, pipeline_dir: str | Path | None = None, run_dir: str | Path | None = None, segments_dir: str | Path | None = None, **scheduler_kwargs)

Schedule a ringdown simulation from the inspiral.

Point the inspiral_run_dir to the last inspiral segment. Also specify ‘inspiral_input_file’ if the simulation was run in a different directory than where the input file is. Parameters for the ringdown will be determined from the inspiral and inserted into the ‘ringdown_input_file_template’. The remaining options are forwarded to the ‘schedule’ command. See ‘schedule’ docs for details.

Here ‘parameters for the ringdown’ includes the information needed to initialize the time-dependent maps, including the shape map. Common horizon shape coefficients in the ringdown distorted frame will be written to disk that the ringdown input file will point to.

Parameters:

  • inspiral_run_dir – Path to the last segment in the inspiral run

  • directory.

  • number_of_ahc_finds_for_fit – The number of ahc finds that will be used

  • fit. (in the)

  • match_time – The time to match the time dependent maps at.

  • settling_timescale – The settling timescale for the rotation and

  • maps. (expansion)

  • zero_coefs_eps – “If the sum of a given coefficient over all

  • 'zero_coefs_eps' ('number_of_ahc_finds_for_fit' is less than)

  • that (set)

  • exactly." (coefficient to 0.0)

  • refinement_level – The initial h refinement level for ringdown.

  • polynomial_order – The initial p refinement level for ringdown.

  • inspiral_input_file – The input file used for during the Inspiral,

  • inspiral_run_dir. (the)

  • ahc_reductions_path – The full path to the BbhReductions file that

  • data (contains AhC)

  • inspiral_run_dir.

  • ahc_subfile – Subfile containing reduction data at times of AhC finds,

  • 'ObservationAhC_Ylm'. (defaults to)

  • fot_vol_h5_path – The full path to any volume data containing the

  • finds (functions of time at the time of AhC)

  • in (defaults to BbhVolume0.h5)

  • inspiral_run_dir.

  • fot_vol_subfile – Subfile containing volume data at times of AhC finds,

  • 'ForContinuation'. (defaults to)

  • path_to_output_h5 – H5 file to output horizon coefficients needed for

  • Ringdown.

  • output_subfile_prefix – Subfile prefix for output data, defaults to

  • 'Distorted'.

  • ringdown_input_file_template – Yaml to insert ringdown coefficients into.