spectre.Pipelines.Bbh.EccentricityControl

Functions

eccentricity_control(h5_file, ...[, ...])

Eccentricity reduction post inspiral.
spectre.Pipelines.Bbh.EccentricityControl.eccentricity_control(h5_file, id_input_file_path, pipeline_dir: str | Path, subfile_name_aha='ApparentHorizons/ControlSystemAhA_Centers.dat', subfile_name_ahb='ApparentHorizons/ControlSystemAhB_Centers.dat', tmin=500, tmax=None, output=None, **scheduler_kwargs)

Eccentricity reduction post inspiral.

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’.

  • Sets the time boundaries for the eccentricity reduction process, starting at 500 and using all available data by default, with the option to adjust ‘tmin’ and ‘tmax’ dynamically.

  • Calls the ‘coordinate_separation_eccentricity_control’ function to calculate the current eccentricity and extract more accurate orbital parameters.

  • Displays the fit results in a tabular format using a pandas DataFrame.

  • If the eccentricity is below a threshold, it prints “Success” and indicates that the simulation can continue.

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

Parameters:

  • h5_file – file that contains the trajectory data

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

  • pipeline_dir – directory where the pipeline outputs are stored.

  • subfile_name_aha – subfile for black hole A; optional parameter

  • subfile_name_ahb – subfile for black hole B; optional parameter

  • tmin – starting point for eccentricity reduction script; defaults to 500 if not specified

  • tmax – stopping point for eccentricity reduction script; set to use all available data by default

  • output – outputs to terminal plus makes pdf file, if specified