petitRADTRANS.planet ==================== .. py:module:: petitRADTRANS.planet .. autoapi-nested-parse:: Stores the Planet object. Classes ------- .. autoapisummary:: petitRADTRANS.planet.Planet Functions --------- .. autoapisummary:: petitRADTRANS.planet._calculate_asymmetric_uncertainty_jax petitRADTRANS.planet.mass2reference_gravity_jax petitRADTRANS.planet.reference_gravity2radius_jax petitRADTRANS.planet.reference_gravity2mass_jax Module Contents --------------- .. py:function:: _calculate_asymmetric_uncertainty_jax(derivatives, uncertainties) .. py:function:: mass2reference_gravity_jax(mass, radius, mass_error_upper=0.0, mass_error_lower=0.0, radius_error_upper=0.0, radius_error_lower=0.0) .. py:function:: reference_gravity2radius_jax(reference_gravity, mass, reference_gravity_error_upper=0.0, reference_gravity_error_lower=0.0, mass_error_upper=0.0, mass_error_lower=0.0) .. py:function:: reference_gravity2mass_jax(reference_gravity, radius, reference_gravity_error_upper=0.0, reference_gravity_error_lower=0.0, radius_error_upper=0.0, radius_error_lower=0.0) .. py:class:: Planet(name, mass=0.0, mass_error_upper=0.0, mass_error_lower=0.0, radius=0.0, radius_error_upper=0.0, radius_error_lower=0.0, orbit_semi_major_axis=0.0, orbit_semi_major_axis_error_upper=0.0, orbit_semi_major_axis_error_lower=0.0, orbital_eccentricity=0.0, orbital_eccentricity_error_upper=0.0, orbital_eccentricity_error_lower=0.0, orbital_inclination=0.0, orbital_inclination_error_upper=0.0, orbital_inclination_error_lower=0.0, orbital_period=0.0, orbital_period_error_upper=0.0, orbital_period_error_lower=0.0, argument_of_periastron=0.0, argument_of_periastron_error_upper=0.0, argument_of_periastron_error_lower=0.0, epoch_of_periastron=0.0, epoch_of_periastron_error_upper=0.0, epoch_of_periastron_error_lower=0.0, ra=0.0, dec=0.0, x=0.0, y=0.0, z=0.0, reference_pressure=0.01, density=0.0, density_error_upper=0.0, density_error_lower=0.0, reference_gravity=0.0, reference_gravity_error_upper=0.0, reference_gravity_error_lower=0.0, equilibrium_temperature=0.0, equilibrium_temperature_error_upper=0.0, equilibrium_temperature_error_lower=0.0, insolation_flux=0.0, insolation_flux_error_upper=0.0, insolation_flux_error_lower=0.0, bond_albedo=0.0, bond_albedo_error_upper=0.0, bond_albedo_error_lower=0.0, transit_depth=0.0, transit_depth_error_upper=0.0, transit_depth_error_lower=0.0, transit_midpoint_time=0.0, transit_midpoint_time_error_upper=0.0, transit_midpoint_time_error_lower=0.0, transit_duration=0.0, transit_duration_error_upper=0.0, transit_duration_error_lower=0.0, projected_obliquity=0.0, projected_obliquity_error_upper=0.0, projected_obliquity_error_lower=0.0, true_obliquity=0.0, true_obliquity_error_upper=0.0, true_obliquity_error_lower=0.0, radial_velocity_semi_amplitude=0.0, radial_velocity_semi_amplitude_error_upper=0.0, radial_velocity_semi_amplitude_error_lower=0.0, planet_stellar_radius_ratio=0.0, planet_stellar_radius_ratio_error_upper=0.0, planet_stellar_radius_ratio_error_lower=0.0, semi_major_axis_stellar_radius_ratio=0.0, semi_major_axis_stellar_radius_ratio_error_upper=0.0, semi_major_axis_stellar_radius_ratio_error_lower=0.0, reference='', discovery_year=0, discovery_method='', discovery_reference='', confirmation_status='', host_name='', star_spectral_type='', star_mass=0.0, star_mass_error_upper=0.0, star_mass_error_lower=0.0, star_radius=0.0, star_radius_error_upper=0.0, star_radius_error_lower=0.0, star_age=0.0, star_age_error_upper=0.0, star_age_error_lower=0.0, star_metallicity=0.0, star_metallicity_error_upper=0.0, star_metallicity_error_lower=0.0, star_effective_temperature=0.0, star_effective_temperature_error_upper=0.0, star_effective_temperature_error_lower=0.0, star_luminosity=0.0, star_luminosity_error_upper=0.0, star_luminosity_error_lower=0.0, star_rotational_period=0.0, star_rotational_period_error_upper=0.0, star_rotational_period_error_lower=0.0, star_radial_velocity=0.0, star_radial_velocity_error_upper=0.0, star_radial_velocity_error_lower=0.0, star_rotational_velocity=0.0, star_rotational_velocity_error_upper=0.0, star_rotational_velocity_error_lower=0.0, star_density=0.0, star_density_error_upper=0.0, star_density_error_lower=0.0, star_reference_gravity=0.0, star_reference_gravity_error_upper=0.0, star_reference_gravity_error_lower=0.0, star_reference='', system_star_number=0, system_planet_number=0, system_moon_number=0, system_distance=0.0, system_distance_error_upper=0.0, system_distance_error_lower=0.0, system_apparent_magnitude_v=0.0, system_apparent_magnitude_v_error_upper=0.0, system_apparent_magnitude_v_error_lower=0.0, system_apparent_magnitude_j=0.0, system_apparent_magnitude_j_error_upper=0.0, system_apparent_magnitude_j_error_lower=0.0, system_apparent_magnitude_k=0.0, system_apparent_magnitude_k_error_upper=0.0, system_apparent_magnitude_k_error_lower=0.0, system_proper_motion=0.0, system_proper_motion_error_upper=0.0, system_proper_motion_error_lower=0.0, system_proper_motion_ra=0.0, system_proper_motion_ra_error_upper=0.0, system_proper_motion_ra_error_lower=0.0, system_proper_motion_dec=0.0, system_proper_motion_dec_error_upper=0.0, system_proper_motion_dec_error_lower=0.0, units=None) Used to store planet- and star-related data and perform useful planet-related operations. The data can be automatically downloaded from the NASA Exoplanet Archive. Args: name: Name of the planet. When using the NASA Exoplanet Archive, the given name is case and space sensitive. mass: (g) Mass of the planet. mass_error_upper: (g) Upper error on the planet's mass. mass_error_lower: (g) Lower error on the planet's mass. radius: (cm) Radius of the planet. radius_error_upper: (cm) Upper error on the planet's radius. radius_error_lower: (cm) Lower error on the planet's radius. orbit_semi_major_axis: (cm) Orbit semi-major-axis of the planet. orbit_semi_major_axis_error_upper: (cm) Upper error on the planet's orbit semi-major-axis. orbit_semi_major_axis_error_lower: (cm) Lower error on the planet's orbit semi-major-axis. orbital_eccentricity: Orbital eccentricity of the planet. orbital_eccentricity_error_upper: Upper error on the planet's orbital eccentricity. orbital_eccentricity_error_lower: Lower error on the planet's orbital eccentricity. orbital_inclination: (deg) Orbital inclination of the planet. orbital_inclination_error_upper: (deg) Upper error on the planet's orbital inclination. orbital_inclination_error_lower: (deg) Lower error on the planet's orbital inclination. orbital_period: (s) Orbital period of the planet. orbital_period_error_upper: (s) orbital_period_error_lower: (s) argument_of_periastron: (deg) Argument of periastron of the planet. argument_of_periastron_error_upper: (deg) argument_of_periastron_error_lower: (deg) epoch_of_periastron: (s) Epoch of periastron of the planet. epoch_of_periastron_error_upper: (s) epoch_of_periastron_error_lower: (s) ra: Right ascension of the planet's star. dec: Declination of the planet's star. x: (cm) Position of the planet in a rectangular coordinate system along the x-axis (not used). y: (cm) Position of the planet in a rectangular coordinate system along the y-axis (not used). z: (cm) Position of the planet in a rectangular coordinate system along the z-axis (not used). reference_pressure: (bar) Reference pressure used to set the planet's radius. density: (g.cm-3) Density of the planet. density_error_upper: (g.cm-3) density_error_lower: (g.cm-3) reference_gravity: reference_gravity_error_upper: (cm.s-2) reference_gravity_error_lower: (cm.s-2) equilibrium_temperature: (K) Equilibrium temperature of the planet. equilibrium_temperature_error_upper: (K) equilibrium_temperature_error_lower: (K) insolation_flux: (erg.s.cm2) Flux received by the planet from its star. insolation_flux_error_upper: (erg.s.cm2) insolation_flux_error_lower: (erg.s.cm2) bond_albedo: Bond albedo of the planet. bond_albedo_error_upper: bond_albedo_error_lower: transit_depth: Transit depth of the planet, relative to its star. transit_depth_error_upper: transit_depth_error_lower: transit_midpoint_time: (s) Mid-transit time of the planet. transit_midpoint_time_error_upper: (s) transit_midpoint_time_error_lower: (s) transit_duration: (s) Duration of the planet's transit. transit_duration_error_upper: (s) transit_duration_error_lower: (s) projected_obliquity: (deg) Projected obliquity of the planet's orbit. projected_obliquity_error_upper: (deg) projected_obliquity_error_lower: (deg) true_obliquity: (deg) True obliquity of the planet's orbit. true_obliquity_error_upper: (deg) true_obliquity_error_lower: (deg) radial_velocity_semi_amplitude: (cm.s-1) Semi-amplitude of the planet's radial velocity from its orbital motion. radial_velocity_semi_amplitude_error_upper: (cm.s-1) radial_velocity_semi_amplitude_error_lower: (cm.s-1) planet_stellar_radius_ratio: Ratio between the planet's radius and its star's. planet_stellar_radius_ratio_error_upper: planet_stellar_radius_ratio_error_lower: semi_major_axis_stellar_radius_ratio: Ratio between the planet's orbit semi-major axis and its star's radius. semi_major_axis_stellar_radius_ratio_error_upper: semi_major_axis_stellar_radius_ratio_error_lower: reference: Reference for the planet's data. discovery_year: Year of discovery of the planet. discovery_method: Method of discovery of the planet. discovery_reference: Reference for the discovery of the planet. confirmation_status: Whether the planet's existence is confirmed. host_name: Name of the planet's host (star). star_spectral_type: Spectral type of the planet's star. star_mass: (g) Mass of the planet's star. star_mass_error_upper: (g) star_mass_error_lower: (g) star_radius: (cm) Radius of the planet's star. star_radius_error_upper: (cm) star_radius_error_lower: (cm) star_age: (s) Age of the planet's star. star_age_error_upper: (s) star_age_error_lower: (s) star_metallicity: Metallicity of the planet's star, relative to the solar metallicity. star_metallicity_error_upper: star_metallicity_error_lower: star_effective_temperature: (K) Effective temperature of the planet's star. star_effective_temperature_error_upper: (K) star_effective_temperature_error_lower: (K) star_luminosity: (erg.s-1) Luminosity of the planet's star. star_luminosity_error_upper: (erg.s-1) star_luminosity_error_lower: (erg.s-1) star_rotational_period: (s) Rotational period of the planet's star. star_rotational_period_error_upper: (s) star_rotational_period_error_lower: (s) star_radial_velocity: (cm.s-1) Radial velocity of the planet's star. star_radial_velocity_error_upper: (cm.s-1) star_radial_velocity_error_lower: (cm.s-1) star_rotational_velocity: (cm.s-1) Rotational velocity of the planet's star. star_rotational_velocity_error_upper: (cm.s-1) star_rotational_velocity_error_lower: (cm.s-1) star_density: (g.cm-3) Density of the planet's star. star_density_error_upper: (g.cm-3) star_density_error_lower: (g.cm-3) star_reference_gravity: (cm.s-2) Reference gravity of the planet's star. star_reference_gravity_error_upper: (cm.s-2) star_reference_gravity_error_lower: (cm.s-2) star_reference: Reference for the data of the planet's star. system_star_number: Number of stars in the planet's system. system_planet_number: Number of planets in the planet's system. system_moon_number: Number of moons in the planet's system. system_distance: (cm) Distance between the Solar system barycenter and the barycenter of the planet's system. system_distance_error_upper: (cm) system_distance_error_lower: (cm) system_apparent_magnitude_v: Apparent magnitude of the planet's star in band V. system_apparent_magnitude_v_error_upper: system_apparent_magnitude_v_error_lower: system_apparent_magnitude_j: Apparent magnitude of the planet's star in band J. system_apparent_magnitude_j_error_upper: system_apparent_magnitude_j_error_lower: system_apparent_magnitude_k: Apparent magnitude of the planet's star in band K. system_apparent_magnitude_k_error_upper: system_apparent_magnitude_k_error_lower: system_proper_motion: (deg.s-1) Total proper motion of the planet's system. system_proper_motion_error_upper: (deg.s-1) system_proper_motion_error_lower: (deg.s-1) system_proper_motion_ra: (deg.s-1) Right ascension proper motion of the planet's system. system_proper_motion_ra_error_upper: (deg.s-1) system_proper_motion_ra_error_lower: (deg.s-1) system_proper_motion_dec: (deg.s-1) Declination proper motion of the planet's system. system_proper_motion_dec_error_upper: (deg.s-1) system_proper_motion_dec_error_lower: (deg.s-1) units: Units of the attributes. .. py:attribute:: name .. py:attribute:: mass :value: 0.0 .. py:attribute:: mass_error_upper :value: 0.0 .. py:attribute:: mass_error_lower :value: 0.0 .. py:attribute:: radius :value: 0.0 .. py:attribute:: radius_error_upper :value: 0.0 .. py:attribute:: radius_error_lower :value: 0.0 .. py:attribute:: orbit_semi_major_axis :value: 0.0 .. py:attribute:: orbit_semi_major_axis_error_upper :value: 0.0 .. py:attribute:: orbit_semi_major_axis_error_lower :value: 0.0 .. py:attribute:: orbital_eccentricity :value: 0.0 .. py:attribute:: orbital_eccentricity_error_upper :value: 0.0 .. py:attribute:: orbital_eccentricity_error_lower :value: 0.0 .. py:attribute:: orbital_inclination :value: 0.0 .. py:attribute:: orbital_inclination_error_upper :value: 0.0 .. py:attribute:: orbital_inclination_error_lower :value: 0.0 .. py:attribute:: orbital_period :value: 0.0 .. py:attribute:: orbital_period_error_upper :value: 0.0 .. py:attribute:: orbital_period_error_lower :value: 0.0 .. py:attribute:: argument_of_periastron :value: 0.0 .. py:attribute:: argument_of_periastron_error_upper :value: 0.0 .. py:attribute:: argument_of_periastron_error_lower :value: 0.0 .. py:attribute:: epoch_of_periastron :value: 0.0 .. py:attribute:: epoch_of_periastron_error_upper :value: 0.0 .. py:attribute:: epoch_of_periastron_error_lower :value: 0.0 .. py:attribute:: ra :value: 0.0 .. py:attribute:: dec :value: 0.0 .. py:attribute:: x :value: 0.0 .. py:attribute:: y :value: 0.0 .. py:attribute:: z :value: 0.0 .. py:attribute:: reference_pressure :value: 0.01 .. py:attribute:: density :value: 0.0 .. py:attribute:: density_error_upper :value: 0.0 .. py:attribute:: density_error_lower :value: 0.0 .. py:attribute:: reference_gravity :value: 0.0 .. py:attribute:: reference_gravity_error_upper :value: 0.0 .. py:attribute:: reference_gravity_error_lower :value: 0.0 .. py:attribute:: equilibrium_temperature :value: 0.0 .. py:attribute:: equilibrium_temperature_error_upper :value: 0.0 .. py:attribute:: equilibrium_temperature_error_lower :value: 0.0 .. py:attribute:: insolation_flux :value: 0.0 .. py:attribute:: insolation_flux_error_upper :value: 0.0 .. py:attribute:: insolation_flux_error_lower :value: 0.0 .. py:attribute:: bond_albedo :value: 0.0 .. py:attribute:: bond_albedo_error_upper :value: 0.0 .. py:attribute:: bond_albedo_error_lower :value: 0.0 .. py:attribute:: transit_depth :value: 0.0 .. py:attribute:: transit_depth_error_upper :value: 0.0 .. py:attribute:: transit_depth_error_lower :value: 0.0 .. py:attribute:: transit_midpoint_time :value: 0.0 .. py:attribute:: transit_midpoint_time_error_upper :value: 0.0 .. py:attribute:: transit_midpoint_time_error_lower :value: 0.0 .. py:attribute:: transit_duration :value: 0.0 .. py:attribute:: transit_duration_error_upper :value: 0.0 .. py:attribute:: transit_duration_error_lower :value: 0.0 .. py:attribute:: projected_obliquity :value: 0.0 .. py:attribute:: projected_obliquity_error_upper :value: 0.0 .. py:attribute:: projected_obliquity_error_lower :value: 0.0 .. py:attribute:: true_obliquity :value: 0.0 .. py:attribute:: true_obliquity_error_upper :value: 0.0 .. py:attribute:: true_obliquity_error_lower :value: 0.0 .. py:attribute:: radial_velocity_semi_amplitude :value: 0.0 .. py:attribute:: radial_velocity_semi_amplitude_error_upper :value: 0.0 .. py:attribute:: radial_velocity_semi_amplitude_error_lower :value: 0.0 .. py:attribute:: planet_stellar_radius_ratio :value: 0.0 .. py:attribute:: planet_stellar_radius_ratio_error_upper :value: 0.0 .. py:attribute:: planet_stellar_radius_ratio_error_lower :value: 0.0 .. py:attribute:: semi_major_axis_stellar_radius_ratio :value: 0.0 .. py:attribute:: semi_major_axis_stellar_radius_ratio_error_upper :value: 0.0 .. py:attribute:: semi_major_axis_stellar_radius_ratio_error_lower :value: 0.0 .. py:attribute:: reference :value: '' .. py:attribute:: discovery_year :value: 0 .. py:attribute:: discovery_method :value: '' .. py:attribute:: discovery_reference :value: '' .. py:attribute:: confirmation_status :value: '' .. py:attribute:: host_name :value: '' .. py:attribute:: star_spectral_type :value: '' .. py:attribute:: star_mass :value: 0.0 .. py:attribute:: star_mass_error_upper :value: 0.0 .. py:attribute:: star_mass_error_lower :value: 0.0 .. py:attribute:: star_radius :value: 0.0 .. py:attribute:: star_radius_error_upper :value: 0.0 .. py:attribute:: star_radius_error_lower :value: 0.0 .. py:attribute:: star_age :value: 0.0 .. py:attribute:: star_age_error_upper :value: 0.0 .. py:attribute:: star_age_error_lower :value: 0.0 .. py:attribute:: star_metallicity :value: 0.0 .. py:attribute:: star_metallicity_error_upper :value: 0.0 .. py:attribute:: star_metallicity_error_lower :value: 0.0 .. py:attribute:: star_effective_temperature :value: 0.0 .. py:attribute:: star_effective_temperature_error_upper :value: 0.0 .. py:attribute:: star_effective_temperature_error_lower :value: 0.0 .. py:attribute:: star_luminosity :value: 0.0 .. py:attribute:: star_luminosity_error_upper :value: 0.0 .. py:attribute:: star_luminosity_error_lower :value: 0.0 .. py:attribute:: star_rotational_period :value: 0.0 .. py:attribute:: star_rotational_period_error_upper :value: 0.0 .. py:attribute:: star_rotational_period_error_lower :value: 0.0 .. py:attribute:: star_radial_velocity :value: 0.0 .. py:attribute:: star_radial_velocity_error_upper :value: 0.0 .. py:attribute:: star_radial_velocity_error_lower :value: 0.0 .. py:attribute:: star_rotational_velocity :value: 0.0 .. py:attribute:: star_rotational_velocity_error_upper :value: 0.0 .. py:attribute:: star_rotational_velocity_error_lower :value: 0.0 .. py:attribute:: star_density :value: 0.0 .. py:attribute:: star_density_error_upper :value: 0.0 .. py:attribute:: star_density_error_lower :value: 0.0 .. py:attribute:: star_reference_gravity :value: 0.0 .. py:attribute:: star_reference_gravity_error_upper :value: 0.0 .. py:attribute:: star_reference_gravity_error_lower :value: 0.0 .. py:attribute:: star_reference :value: '' .. py:attribute:: system_star_number :value: 0 .. py:attribute:: system_planet_number :value: 0 .. py:attribute:: system_moon_number :value: 0 .. py:attribute:: system_distance :value: 0.0 .. py:attribute:: system_distance_error_upper :value: 0.0 .. py:attribute:: system_distance_error_lower :value: 0.0 .. py:attribute:: system_apparent_magnitude_v :value: 0.0 .. py:attribute:: system_apparent_magnitude_v_error_upper :value: 0.0 .. py:attribute:: system_apparent_magnitude_v_error_lower :value: 0.0 .. py:attribute:: system_apparent_magnitude_j :value: 0.0 .. py:attribute:: system_apparent_magnitude_j_error_upper :value: 0.0 .. py:attribute:: system_apparent_magnitude_j_error_lower :value: 0.0 .. py:attribute:: system_apparent_magnitude_k :value: 0.0 .. py:attribute:: system_apparent_magnitude_k_error_upper :value: 0.0 .. py:attribute:: system_apparent_magnitude_k_error_lower :value: 0.0 .. py:attribute:: system_proper_motion :value: 0.0 .. py:attribute:: system_proper_motion_error_upper :value: 0.0 .. py:attribute:: system_proper_motion_error_lower :value: 0.0 .. py:attribute:: system_proper_motion_ra :value: 0.0 .. py:attribute:: system_proper_motion_ra_error_upper :value: 0.0 .. py:attribute:: system_proper_motion_ra_error_lower :value: 0.0 .. py:attribute:: system_proper_motion_dec :value: 0.0 .. py:attribute:: system_proper_motion_dec_error_upper :value: 0.0 .. py:attribute:: system_proper_motion_dec_error_lower :value: 0.0 .. py:method:: _convert_nasa_exoplanet_archive(value, key, verbose=False, use_best_mass=False) :staticmethod: .. py:method:: _select_best_in_column(dictionary) :staticmethod: .. py:method:: bjd_utc2bjd_tdb(times_utc, ra, dec, site_name=None, latitude=None, longitude=None, height=None) :staticmethod: .. py:method:: calculate_airmass(time, site_name=None, latitude=None, longitude=None, height=None, time_format='mjd') .. py:method:: calculate_barycentric_velocities(time, site_name=None, latitude=None, longitude=None, height=None, time_format='mjd') .. py:method:: calculate_equilibrium_temperature() Calculate the equilibrium temperature of a planet. .. py:method:: calculate_intrinsic_temperature() -> tuple[float, float, float] Calculate the intrinsic temperature of a planet. .. py:method:: calculate_intrinsic_temperature_inflated(equilibrium_temperature: float = None) -> float Calculate the intrinsic temperature of inflated hot Jupiters. .. py:method:: calculate_intrinsic_temperature_leconte(quality_factor: float, love_number_2: float, emissivity: float = 1) -> float Calculate the intrinsic temperature from the tidal heating rate. Source: Leconte et al. 2010 http://dx.doi.org/10.1051/0004-6361/201014337 (Eq. 23). This makes 3 major assumptions: 1. the eccentricity is small (<~0.2), 2. the planet is near synchronization, i.e. angular_speed (omega_p) ~ rotation frequency (n), 3. the tidal heating rate is evenly deposited near the "surface" of the planet. The main unknowns of this equation are `quality_factor` (Q) and `love_number_2` (k2), but what matters most is the value of k2/Q, which may be easier to find that the individual parameters. The k2/Q value can be given to this function e.g. by setting `love_number_2=1` and `quality_factor=1 / (k2/Q)`. Typical k2/Q values are (Lainey et al. 2015, https://arxiv.org/pdf/1604.04184): - Earth-like: ~1e-3 - Neptune-like: ~1e-4 - Saturn-like: ~2e-4 - Jupiter-like: ~1e-5 With typical k2 values ranging from ~0.1 to ~1.0, and typical Q values ranging from 1e2 to 1e6. These values are often given with high uncertainties. Args: quality_factor: float Quality factor of the planet (a.k.a. "Q"). In some works, the reduced quality factor (Q') is used. Its relationship with Q is given by: Q' = 3Q / (2 * k2), Where k2 is the Love number of degree 2 of the planet. love_number_2: float Love number of degree 2 of the planet (a.k.a. "k2"). Default is 3/2, the value for a homogeneous sphere. emissivity: Emissivity of the planet. Default is 1. Returns: (K) The intrinsic temperature of the planet, according to Leconte et al. 2010 (Eq. 23). .. py:method:: calculate_full_transit_duration() .. py:method:: calculate_impact_parameter() .. py:method:: calculate_mid_transit_time(observation_day, source_mid_transit_time=None, source_mid_transit_time_error_lower=None, source_mid_transit_time_error_upper=None, day2second=True) .. py:method:: calculate_orbital_longitudes(times, longitude_start=0, rad2deg=True) .. py:method:: calculate_orbital_phases(times, phase_start=0) .. py:method:: calculate_orbital_velocity() .. py:method:: calculate_radial_velocity(orbital_longitude) .. py:method:: calculate_radial_velocity_semi_amplitude() .. py:method:: compute_airmass(ra, dec, time, site_name=None, latitude=None, longitude=None, height=None, time_format='mjd') :staticmethod: .. py:method:: compute_barycentric_velocities(ra, dec, time, site_name=None, latitude=None, longitude=None, height=None, time_format='mjd') :staticmethod: .. py:method:: compute_equilibrium_temperature(orbit_semi_major_axis, star_effective_temperature, star_radius, bond_albedo: float = 0, orbit_semi_major_axis_error_lower: float = 0, orbit_semi_major_axis_error_upper: float = 0, star_effective_temperature_error_lower: float = 0, star_effective_temperature_error_upper: float = 0, star_radius_error_lower: float = 0, star_radius_error_upper: float = 0) :staticmethod: Calculate the equilibrium temperature of a planet. .. py:method:: compute_full_transit_duration(total_transit_duration, planet_radius, star_radius, impact_parameter) :staticmethod: .. py:method:: compute_impact_parameter(orbit_semi_major_axis, orbital_inclination, star_radius) :staticmethod: .. py:method:: compute_intrinsic_temperature(mass: float, radius: float, star_age: float, mass_error_lower: float = 0.0, mass_error_upper: float = 0.0, radius_error_lower: float = 0.0, radius_error_upper: float = 0.0, star_age_error_lower: float = 0.0, star_age_error_upper: float = 0.0) -> tuple[float, float, float] :staticmethod: Calculate the intrinsic temperature of an irradiated planet. The star's age must be greater than 1 Gyr and the planet's mass lower than 1 Jupiter mass. Source: Rogers&Seager 2010 https://www.doi.org/10.1088/0004-637X/712/2/974 (Eq. 19 and 20) Args: mass: (g) mass of the planet radius: (cm) radius of the planet star_age: (s) age of the planet's star mass_error_lower: (g) lower error on the planet's mass mass_error_upper: (g) upper error on the planet's mass radius_error_lower: (cm) lower error on the planet's radius radius_error_upper: (cm) upper error on the planet's radius star_age_error_lower: (s) lower error on the planet's star's age star_age_error_upper: (s) upper error on the planet's star's age Returns: The intrinsic temperature in K, and its associated lower and upper uncertainties. .. py:method:: compute_intrinsic_temperature_inflated(equilibrium_temperature: float) -> float :staticmethod: Calculate the intrinsic temperature of an inflated hot Jupiter. This is valid for hot Jupiters with masses between 0.1 and 10 M_Jup, and equilibrium temperatures between ~700 K and ~2800 K. Source: Thorngren et al. 2019 https://www.doi.org/10.3847/2041-8213/ab43d0 (Eq. 3) Corrected source: https://www.doi.org/10.3847/2041-8213/ab6d6c The article forget to mention that the flux must be scaled by 1e-9 (in CGS) to match the amplitude of the curve in their Fig. 1. Args: equilibrium_temperature: (K) equilibrium temperature of the planet Returns: The intrinsic temperature in K, and its associated lower and upper uncertainties. .. py:method:: compute_intrinsic_temperature_leconte(quality_factor: float, radius: float, orbit_semi_major_axis: float, orbital_velocity: float, orbital_eccentricity: float, star_mass: float, love_number_2: float = 1.5, emissivity: float = 1) -> float :staticmethod: Calculate the intrinsic temperature from the tidal heating rate. Source: Leconte et al. 2010 http://dx.doi.org/10.1051/0004-6361/201014337 (Eq. 23). This makes 3 major assumptions: 1. the eccentricity is small (<~0.2, see Leconte et al. 2010, fig. 2), 2. the planet is near synchronization, i.e. angular_speed (omega_p) ~ rotation frequency (n), 3. the tidal heating rate is evenly deposited near the "surface" of the planet. The main unknowns of this equation are `quality_factor` (Q) and `love_number_2` (k2), but what matters most is the value of k2/Q, which may be easier to find that the individual parameters. The k2/Q value can be given to this function e.g. by setting `love_number_2=1` and `quality_factor=1 / (k2/Q)`. Typical k2/Q values are (Lainey et al. 2015, https://arxiv.org/pdf/1604.04184): - Earth-like: ~1e-3 - Neptune-like: ~1e-4 - Saturn-like: ~2e-4 - Jupiter-like: ~1e-5 With typical k2 values ranging from ~0.1 to ~1.0, and typical Q values ranging from 1e2 to 1e6. These values are often given with high uncertainties. Args: quality_factor: float Quality factor of the planet (a.k.a. "Q"). In some works, the reduced quality factor (Q') is used. Its relationship with Q is given by: Q' = 3Q / (2 * k2), Where k2 is the Love number of degree 2 of the planet. radius: float (cm) Radius of the planet. orbit_semi_major_axis: float (cm) Semi-major axis of the planet's orbit. orbital_velocity: float (cm.s-1) Orbital velocity of the planet. orbital_eccentricity: Eccentricity of the planet's orbit. star_mass: float (g) Mass of the planet's star love_number_2: float Love number of degree 2 of the planet (a.k.a. "k2"). Default is 3/2, the value for a homogeneous sphere. emissivity: Emissivity of the planet. Default is 1. Returns: (K) The intrinsic temperature of the planet, according to Leconte et al. 2010 (Eq. 23). .. py:method:: compute_mid_transit_time_from_source(observation_day, source_mid_transit_time, source_mid_transit_time_error_lower, source_mid_transit_time_error_upper, orbital_period, orbital_period_error_lower, orbital_period_error_upper, day2second=True) :staticmethod: .. py:method:: compute_orbital_longitudes(times, orbital_period, longitude_start, rad2deg: bool = True) :staticmethod: Calculate orbital longitudes assuming low eccentricity. Args: times: (s) time array orbital_period: (s) orbital period of the planet longitude_start: (rad) planet longitude at the start of observations rad2deg: if True, convert the longitudes from radians to degrees Returns: The orbital longitudes at the given times .. py:method:: compute_orbital_phases(phase_start, orbital_period, times) :staticmethod: Calculate orbital phases assuming low eccentricity. Args: phase_start: planet phase at the start of observations orbital_period: (s) orbital period of the planet times: (s) time array Returns: The orbital phases for the given time .. py:method:: compute_orbital_velocity(star_mass, orbit_semi_major_axis) :staticmethod: Calculate an approximation of the orbital velocity. This equation is valid if the mass of the object is negligible compared to the mass of the star, and if the eccentricity of the object is close to 0. Args: star_mass: (g) mass of the star orbit_semi_major_axis: (cm) semi-major axis of the orbit of the object Returns: (cm.s-1) the mean orbital velocity, assuming 0 eccentricity and mass_object << mass_star .. py:method:: compute_radial_velocity(radial_velocity_semi_amplitude, orbital_longitude) :staticmethod: Calculate the planet radial velocity as seen by an observer. Args: radial_velocity_semi_amplitude: (cm.s-1) radial velocity semi amplitude of the planet (aka Kp). orbital_longitude: (degree) angle between the closest point from the observer on the planet orbit and the planet position, i.e. if the planet orbital inclination is 0 degree, 0 degree: mid-primary transit point, 180 degree: mid-secondary eclipse point Returns: .. py:method:: compute_radial_velocity_semi_amplitude(orbital_velocity, orbital_inclination) :staticmethod: Args: orbital_velocity: orbital_inclination: (degree) angle between the normal of the planet orbital plane and the axis of observation, i.e. 90 degree: edge view, 0 degree: top view Returns: .. py:method:: download_from_nasa_exoplanet_archive(search_request, tap_service='https://exoplanetarchive.ipac.caltech.edu/TAP') :staticmethod: .. py:method:: download_planet_from_nasa_exoplanet_archive(name) :staticmethod: .. py:method:: from_tab_file(filename, use_best_mass=True) :classmethod: Read from a NASA Exoplanet Archive Database .tab file. Args: filename: file to read use_best_mass: if True, use NASA Exoplanet Archive Database 'bmass' argument instead of 'mass'. Returns: planets: a list of Planet objects .. py:method:: from_votable(votable) :classmethod: .. py:method:: from_votable_file(filename) :classmethod: .. py:method:: generate_filename(name, directory=None) :staticmethod: .. py:method:: get(name) :classmethod: .. py:method:: get_astropy_coordinates(ra, dec, site_name=None, latitude=None, longitude=None, height=None) :staticmethod: .. py:method:: get_default_directory(path_input_data=None) :staticmethod: .. py:method:: get_filename() .. py:method:: get_from(name, filename) :classmethod: .. py:method:: load(name, filename=None) :classmethod: .. py:method:: mass2reference_gravity(mass, radius, mass_error_upper=0.0, mass_error_lower=0.0, radius_error_upper=0.0, radius_error_lower=0.0) :staticmethod: Convert the mass of a planet to its surface gravity. Args: mass: (g) mass of the planet radius: (cm) radius of the planet mass_error_upper: (g) upper error on the planet mass mass_error_lower: (g) lower error on the planet mass radius_error_upper: (cm) upper error on the planet radius radius_error_lower: (cm) lower error on the planet radius Returns: (cm.s-2) the reference gravity of the planet, and its upper and lower error .. py:method:: reference_gravity2radius(reference_gravity, mass, reference_gravity_error_upper=0.0, reference_gravity_error_lower=0.0, mass_error_upper=0.0, mass_error_lower=0.0) :staticmethod: Convert the mass of a planet to its reference gravity. Args: reference_gravity: (cm.s-2) reference gravity of the planet mass: (g) mass of the planet mass_error_upper: (g) upper error on the planet mass mass_error_lower: (g) lower error on the planet mass reference_gravity_error_upper: (cm.s-2) upper error on the planet radius reference_gravity_error_lower: (cm.s-2) lower error on the planet radius Returns: (cm.s-2) the surface gravity of the planet, and its upper and lower error .. py:method:: reference_gravity2mass(reference_gravity, radius, reference_gravity_error_upper=0.0, reference_gravity_error_lower=0.0, radius_error_upper=0.0, radius_error_lower=0.0) :staticmethod: Convert the surface gravity of a planet to its mass. Args: reference_gravity: (cm.s-2) reference gravity of the planet radius: (cm) radius of the planet reference_gravity_error_upper: (cm.s-2) upper error on the planet surface gravity reference_gravity_error_lower: (cm.s-2) lower error on the planet surface gravity radius_error_upper: (cm) upper error on the planet radius radius_error_lower: (cm) lower error on the planet radius Returns: (g) the mass of the planet, and its upper and lower error .. py:method:: save(filename=None)