spectre.Pipelines.EccentricityControl.EccentricityControlParams

Functions

eccentricity_control_params(h5_files, ...[, ...])

Get new orbital parameters for a binary system to control eccentricity.

eccentricity_control_params_options(f)

CLI options for the 'eccentricity_control_params' function.
spectre.Pipelines.EccentricityControl.EccentricityControlParams.eccentricity_control_params(h5_files: str | Path | Sequence[str | Path], id_input_file_path: str | Path, subfile_name_aha_trajectories: str = DEFAULT_AHA_TRAJECTORIES, subfile_name_ahb_trajectories: str = DEFAULT_AHB_TRAJECTORIES, subfile_name_aha_quantities: str = 'ObservationAhA.dat', subfile_name_ahb_quantities: str = 'ObservationAhB.dat', tmin: float | None = None, tmax: float | None = None, plot_output_dir: str | Path | None = None, ecc_params_output_file: str | Path | None = None) → Dict[Literal['Eccentricity', 'EccentricityError', 'Omega0', 'Adot0', 'D0', 'DeltaOmega0', 'DeltaAdot0', 'DeltaD0', 'NewOmega0', 'NewAdot0', 'NewD0', 'Tmin', 'Tmax'], float]

Get new orbital parameters for a binary system to control eccentricity.

The eccentricity is estimated from the trajectories of the binary objects and updates to the orbital parameters are suggested to drive the orbit to the target eccentricity, using SpEC’s OmegaDotEccRemoval.py. Currently supports only circular target orbits (target eccentricity = 0).

Parameters:

  • h5_files – Paths to the H5 files containing the trajectory data (e.g. BbhReductions.h5). Can also be a glob pattern.

  • id_input_file_path – Path to the initial data input file from which the evolution started. This file contains the initial data parameters that are being controlled.

  • subfile_name_aha_trajectories – (Optional) Name of the subfile containing the apparent horizon centers for object A.

  • subfile_name_ahb_trajectories – (Optional) Name of the subfile containing the apparent horizon centers for object B.

  • subfile_name_aha_quantities – (Optional) Name of the subfile containing the quantities measured on apparent horizon A (masses and spins).

  • subfile_name_ahb_quantities – (Optional) Name of the subfile containing the quantities measured on apparent horizon B (masses and spins).

  • tmin – (Optional) The lower time bound for the eccentricity estimate. Used to remove initial junk and transients in the data. If unspecified, uses SpEC’s ‘OmegaDotEccRemoval.FindTmin’ to estimate it.

  • tmax – (Optional) The upper time bound for the eccentricity estimate. A reasonable value would include 2-3 orbits. Default is ‘500 + 5 * pi / Omega0’.

  • plot_output_dir – (Optional) Output directory for plots.

  • ecc_params_output_file – (Optional) Output file for the results.

Returns:

Dictionary with the keys listed in ‘EccentricityParams’.

spectre.Pipelines.EccentricityControl.EccentricityControlParams.eccentricity_control_params_options(f)

CLI options for the ‘eccentricity_control_params’ function.

These options can be used by CLI commands that call the ‘eccentricity_control_params’ function.