TidalPy.utilities.conversions package

Submodules

TidalPy.utilities.conversions.conversions module

TidalPy.utilities.conversions.conversions.Au2m(astronomical_units: float | float64 | ndarray) → float | float64 | ndarray[source]

Convert Meters to Astronomical Units

Parameters:: astronomical_units (FloatArray) – Distance in [Au]
Returns:: meters – Distance in [m]
Return type:: FloatArray

TidalPy.utilities.conversions.conversions.days2rads(days: float | float64 | ndarray) → float | float64 | ndarray[source]

Convert from period [days] to frequency [rads s-1]

Parameters:: days (FloatArray) – Period in [days]
Returns:: radians_per_second – Frequency in [rads s-1]
Return type:: FloatArray

TidalPy.utilities.conversions.conversions.m2Au(meters: float | float64 | ndarray) → float | float64 | ndarray[source]

Convert Meters to Astronomical Units

Parameters:: meters (FloatArray) – Distance in [m]
Returns:: astronomical_units – Distance in [Au]
Return type:: FloatArray

TidalPy.utilities.conversions.conversions.myr2sec(myrs: float | float64 | ndarray) → float | float64 | ndarray[source]

Convert time from millions of years to seconds

Parameters:: myrs (FloatArray) – Time in [Myr]
Returns:: seconds – Time in [sec]
Return type:: FloatArray

TidalPy.utilities.conversions.conversions.orbital_motion2semi_a(orbital_motion: float | float64 | ndarray, host_mass: float, target_mass: float = 0.0) → float | float64 | ndarray[source]

Convert orbital mean motion to semi-major axis (Kepler’s 3rd law)

Parameters:

orbital_motion (FloatArray) – Orbital motion in [rads s-1]
host_mass (float) – Central body’s mass in [kg]
target_mass (float = 0.) – Target (or orbiting) body’s mass in [kg]

Returns:

semi_major_axis – Semi-major axis in [m]

Return type:

FloatArray

TidalPy.utilities.conversions.conversions.rads2days(radians_per_second: float | float64 | ndarray) → float | float64 | ndarray[source]

Convert from frequency [rads s-1] to period [days]

Parameters:: radians_per_second (FloatArray) – Frequency in [rads s-1]
Returns:: days – Period in [days]
Return type:: FloatArray

TidalPy.utilities.conversions.conversions.sec2myr(seconds: float | float64 | ndarray) → float | float64 | ndarray[source]

Convert time from seconds to millions of years

Parameters:: seconds (FloatArray) – Time in [sec]
Returns:: myrs – Time in [Myr]
Return type:: FloatArray

TidalPy.utilities.conversions.conversions.semi_a2orbital_motion(semi_major_axis: float | float64 | ndarray, host_mass: float, target_mass: float = 0.0) → float | float64 | ndarray[source]

Convert semi-major axis to mean orbital motion (Kepler’s 3rd law)

Parameters:

semi_major_axis (FloatArray) – Semi-major axis in [m]
host_mass (float) – Central body’s mass in [kg]
target_mass (float = 0.) – Target (or orbiting) body’s mass in [kg]

Returns:

orbital_motion – Orbital motion in [rads s-1]

Return type:

FloatArray

TidalPy.utilities.conversions.conversions_x module

TidalPy.utilities.conversions.conversions_x.Au2m(astronomical_units)

Convert Meters to Astronomical Units

Parameters:: astronomical_units (double) – Distance in [Au]
Returns:: meters – Distance in [m]
Return type:: double

TidalPy.utilities.conversions.conversions_x.days2rads(days)

Convert from period [days] to frequency [rads s-1]

Parameters:: days (double) – Period in [days]
Returns:: radians_per_second – Frequency in [rads s-1]
Return type:: double

TidalPy.utilities.conversions.conversions_x.m2Au(meters)

Convert Meters to Astronomical Units

Parameters:: meters (FloatArray) – Distance in [m]
Returns:: astronomical_units – Distance in [Au]
Return type:: FloatArray

TidalPy.utilities.conversions.conversions_x.myr2sec(myrs)

Convert time from millions of years to seconds

Parameters:: myrs (double) – Time in [Myr]
Returns:: seconds – Time in [sec]
Return type:: double

TidalPy.utilities.conversions.conversions_x.orbital_motion2semi_a(orbital_motion, host_mass, target_mass=0.0, G_to_use=6.6743e-11)

Convert orbital mean motion to semi-major axis (Kepler’s 3rd law)

Parameters:

orbital_motion (double) – Orbital motion in [rads s-1]
host_mass (double) – Central body’s mass in [kg]
target_mass (double, default = 0) – Target (or orbiting) body’s mass in [kg]
G_to_use (double, default = d_G) – Gravitational constant [N m2 kg-2]

Returns:

semi_major_axis – Semi-major axis in [m]

Return type:

double

TidalPy.utilities.conversions.conversions_x.rads2days(radians_per_second)

Convert from frequency [rads s-1] to period [days]

Parameters:: radians_per_second (FloatArray) – Frequency in [rads s-1]
Returns:: days – Period in [days]
Return type:: FloatArray

TidalPy.utilities.conversions.conversions_x.sec2myr(seconds)

Convert time from seconds to millions of years

Parameters:: seconds (double) – Time in [sec]
Returns:: myrs – Time in [Myr]
Return type:: double

TidalPy.utilities.conversions.conversions_x.semi_a2orbital_motion(semi_major_axis, host_mass, target_mass=0.0, G_to_use=6.6743e-11)

Convert semi-major axis to mean orbital motion (Kepler’s 3rd law)

Parameters:

semi_major_axis (double) – Semi-major axis in [m]
host_mass (double) – Central body’s mass in [kg]
target_mass (double, default = 0) – Target (or orbiting) body’s mass in [kg]
G_to_use (double, default = d_G) – Gravitational constant [N m2 kg-2]

Returns:

orbital_motion – Orbital motion in [rads s-1]

Return type:

double

TidalPy.utilities.conversions.timing module

TidalPy.utilities.conversions.timing.convert_to_hms(seconds: float) → Tuple[int, int, int, float][source]

Convert seconds to a tuple of days, hours, minutes, seconds

Parameters:

seconds (float) – Time in seconds

Returns:

days (int) – Days
hours (int) – Hours
minutes (int) – Minutes
seconds (float) – Remaining seconds after conversion