PlanetParameters#

class VSPEC.params.PlanetParameters(name: str, radius: astropy.units.Quantity, gravity: GravityParameters, semimajor_axis: astropy.units.Quantity, orbit_period: astropy.units.Quantity, rotation_period: astropy.units.Quantity, eccentricity: float, obliquity: astropy.units.Quantity, obliquity_direction: astropy.units.Quantity, init_phase: astropy.units.Quantity, init_substellar_lon: astropy.units.Quantity)#

Bases: BaseParameters

Class representing planet parameters.

Parameters:

name (str) – The name of the planet. Any characters are allowed. If you find that PSG is changing the name internally please submit an issue.
radius (astropy.units.Quantity) – The radius of the planet.
gravity (GravityParameters) – The gravity parameters of the planet.
semimajor_axis (astropy.units.Quantity) – The semi-major axis of the planet’s orbit.
orbit_period (astropy.units.Quantity) – The period of the planet’s orbit.
rotation_period (astropy.units.Quantity) – The rotation period of the planet.
eccentricity (float) – The eccentricity of the planet’s orbit
obliquity (astropy.units.Quantity) – The obliquity (tilt) of the planet.
obliquity_direction (astropy.units.Quantity) – The direction of the planet’s obliquity. The true anomaly at which the planet’s north pole faces away from the star.
init_phase (astropy.units.Quantity) – The initial phase of the planet.
init_substellar_lon (astropy.units.Quantity) – The initial substellar longitude of the planet.

name#

The name of the planet.

Type:: str

radius#

The radius of the planet.

Type:: astropy.units.Quantity

gravity#

The gravity parameters of the planet.

Type:: GravityParameters

semimajor_axis#

The semi-major axis of the planet’s orbit.

Type:: astropy.units.Quantity

orbit_period#

The period of the planet’s orbit.

Type:: astropy.units.Quantity

rotation_period#

The rotation period of the planet.

Type:: astropy.units.Quantity

eccentricity#

The eccentricity of the planet’s orbit

Type:: float

obliquity#

The obliquity (tilt) of the planet.

Type:: astropy.units.Quantity

obliquity_direction#

The direction of the planet’s obliquity. The true anomaly at which the planet’s north pole faces away from the star.

Type:: astropy.units.Quantity

init_phase#

The initial phase of the planet.

Type:: astropy.units.Quantity

init_substellar_lon#

The initial substellar longitude of the planet.

Type:: astropy.units.Quantity

Notes

The proxcenb class method initializes parameters specific to Proxima Centauri b.
The std class method initializes parameters for a standard exoplanet.

Methods Summary

`proxcenb`(init_phase, init_substellar_lon)	Proxima Centauri b [Faria et al., 2022]
`std`(init_phase, init_substellar_lon)	The default VSPEC planet.

Methods Documentation

classmethod proxcenb(init_phase: astropy.units.Quantity, init_substellar_lon: astropy.units.Quantity)#

Proxima Centauri b [Faria et al., 2022]

Parameters:

init_phase (astropy.units.Quantity) – The initial phase of the planet.
init_substellar_lon (astropy.units.Quantity) – The initial subsolar longitude of the planet.

Returns:

The planet parameters for Proxima Centauri b.

Return type:

PlanetParameters

classmethod std(init_phase: astropy.units.Quantity, init_substellar_lon: astropy.units.Quantity)#

The default VSPEC planet.

Parameters:

init_phase (astropy.units.Quantity) – The initial phase of the planet.
init_substellar_lon (astropy.units.Quantity) – The initial subsolar longitude of the planet.

Returns:

The planet parameters for the default VSPEC exoplanet.

Return type:

PlanetParameters