orbital_evolution.command_line_util module

Class Inheritance Diagram

Add and use commandline/config file options for defining evolution to run.

orbital_evolution.command_line_util.add_binary_config(parser, skip=(), require_secondary=False)

Add command line/config file options to specify the binary to evolve.

Parameters:

• parser – The command line/cornfig file parser, or argument group, to add the options to.
• skip – Collection of configuration options to exclude. Presumaly those will be denifen in some other way.
• require_secondary (bool) – If true, removes the possibility of leaving secondary mass unspecified.

Returns:

None

orbital_evolution.command_line_util.add_evolution_config(parser)

Add command line/config file options to specify how to run the evolution.

Parameters:parser – The command line/cornfig file parser, or argument group, to add the options to. Returns:None

orbital_evolution.command_line_util.add_star_config(parser, primary=True, require_secondary=False)

Add to the parser arguments to configure a star.

By default add arguments to configure the primary, use primary=False to configure the secondary. Secondary arguments other than mass all have None default values to allow falling back to the primary’s values.

Parameters:

• parser – The command line/cornfig file parser, or argument group, to add the options to.
• primary (bool) – Whether the star being configured is the primary or the secondary in the system.
• require_secondary (bool) – If true, removes the possibility of leaving secondary mass unspecified.

Returns:

None

orbital_evolution.command_line_util.create_planet(mass=<Quantity 0.00095459>, radius=<Quantity 0.10276269>, phase_lag=0.0)

Return a configured planet to use in the evolution.

orbital_evolution.command_line_util.create_star(interpolator, convective_phase_lag, *, mass=1.0, metallicity=0.0, wind_strength=0.17, wind_saturation_frequency=2.45, diff_rot_coupling_timescale=0.005, interp_age=None)

Create the star to use in the evolution.

orbital_evolution.command_line_util.create_system(primary, secondary, disk_lock_frequency, *, initial_eccentricity=0.0, porb_initial=3.5, disk_dissipation_age=0.004, initial_inclination=0.0, secondary_formation_age=None)

Combine the given primary and secondar in a system ready to evolve.

orbital_evolution.command_line_util.get_binary(cmdline_args, interpolator)

Return the fully constructed binary to evolve.

orbital_evolution.command_line_util.get_component(cmdline_args, interpolator, primary=True)

Return one of the components of the system.

orbital_evolution.command_line_util.get_phase_lag_config(cmdline_args, primary=True)

Return a phase lag configuration to pass directly to create_star.

orbital_evolution.command_line_util.run_evolution(cmdline_args, interpolator=None, required_ages_only=False, **extra_evolve_args)

Run the evolution specified on the command line.

orbital_evolution.command_line_util.set_up_library(cmdline_args)

Define eccentricity expansion and return stellar evol interpolator.