spectre.Pipelines.Bbh.EccentricityControl

Functions

eccentricity_control(h5_files, ...[, tmin, ...])

Adjust orbital parameters for eccentricity control.
spectre.Pipelines.Bbh.EccentricityControl.eccentricity_control(h5_files: str | Path | Sequence[str | Path], id_input_file_path: str | Path, pipeline_dir: str | Path, tmin: float | None = None, tmax: float | None = None, plot_output_dir: str | Path | None = None, ecc_params_output_file: str | Path | None = None, evolve: bool = True, branch_levs_when_complete: Sequence[int] | None = None, inspiral_input_file_path: str | Path | None = None, inspiral_run_dir: str | Path | None = None, inspiral_input_file_template: str | Path = INSPIRAL_INPUT_FILE_TEMPLATE, **scheduler_kwargs)

Adjust orbital parameters for eccentricity control.

This function can be called after the inspiral has run (see the ‘Next’ section of the Inspiral.yaml file).

This function does the following:

  • Reads orbital parameters from the ‘id_input_file_path’.

  • Get the new orbital parameters by calling the function ‘eccentricity_control_params’ in ‘spectre.Pipelines.EccentricityControl.EccentricityControl’. See this function for default values and more details on the arguments.

  • If the eccentricity is below an absolute tolerance, continue the evolution.

  • Generates new initial data based on updated orbital parameters using the ‘generate_id’ function.

Parameters:

  • h5_files – files that contain the trajectory data

  • id_input_file_path – path to the input file of the initial data run

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

  • evolve – Evolve the initial data after generation to continue eccentricity control. You can disable this to generate only the new initial data if you want to manually start the next inspiral.

  • branch_levs_when_complete – Optional list of levs to start when eccentricity control is complete. Each lev continues in the ‘Lev’ subdirectory of the current eccentricity-control iteration, so the lev that was just run continues its sequence of segments and others branch into a new directory. If no levs are specified, the simulation will just stop after eccentricity control. See Inspiral.INSPIRAL_LEVS for the definition of the levs.

  • inspiral_input_file_path – Path to the input file for the inspiral run. Required only if branch_levs_when_complete is specified, as the simulation will continue from this data.

  • inspiral_run_dir – Directory where the inspiral run was executed. Defaults to the directory of the inspiral_input_file_path.

  • inspiral_input_file_template – Input file template to start the branch_levs_when_complete. Defaults to the INSPIRAL_INPUT_FILE_TEMPLATE.

See the ‘eccentricity_control_params’ function for details on the other arguments, as well as the ‘schedule’ function for the scheduling options.