TidalPy.structures.helpers package

Submodules

TidalPy.structures.helpers.orbit_config module

TidalPy.structures.helpers.orbit_config.pull_out_orbit_from_config(world_config: dict) → Tuple[float, float, float]

Parse a user-provided configuration dict and pull out any orbital information.

Also perform some sanity checks and conversions.

Parameters:

world_config (dict) – User-provided world configuration

Returns:

• orbital_freq (float) – Orbital mean motion [rad s-1]

• semi_major_axis (float) – Orbital separation [m]

• eccentricity (float) – Orbital eccentricity