psgParameters#

class VSPEC.params.gcm.psgParameters(gcm_binning: int, phase_binning: int, use_molecular_signatures: bool, nmax: int, lmax: int, continuum: list)#

Bases: BaseParameters

Class to store parameters for the Planetary Spectrum Generator (PSG).

Parameters:

  • gcm_binning (int) – Number of spatial points to bin together in the GCM data. Use 3 for science.

  • phase_binning (int) – Number of phase epochs to bin together when simulating the planet. These are later interpolated to match the cadence of the variable star simulation.

  • use_molecular_signatures (bool) – Whether to use molecular signatures (PSG atmosphere) or not.

  • nmax (int) – PSG handbook: ‘When performing scattering aerosols calculations, this parameter indicates the number of n-stream pairs - Use 0 for extinction calculations only (e.g. transit, occultation)’ [Villanueva et al., 2022]

  • lmax (int) – PSG handbook: ‘When performing scattering aerosols calculations, this parameter indicates the number of scattering Legendre polynomials used for describing the phase function - Use 0 for extinction calculations only (e.g. transit, occultation)’ [Villanueva et al., 2022]

  • continuum (list of str) – The continuum opacities to include in the radiative transfer calculation, such as ‘Rayleigh’, ‘Refraction’, ‘CIA_all’.

  • url (str) – URL of the Planetary Spectrum Generator.

  • api_key (APIkey) – An instance of the APIkey class representing the PSG API key. Provide either the path to the API key file or the API key value.

gcm_binning#

Number of spatial points to bin together in the GCM data.

Type:

int

phase_binning#

Number of phase epochs to bin together when simulating the planet.

Type:

int

use_molecular_signatures#

Whether to use molecular signatures (PSG atmosphere) or not.

Type:

bool

nmax#

PSG handbook: ‘When performing scattering aerosols calculations, this parameter indicates the number of n-stream pairs - Use 0 for extinction calculations only (e.g. transit, occultation)’ [Villanueva et al., 2022]

Type:

int

lmax#

PSG handbook: ‘When performing scattering aerosols calculations, this parameter indicates the number of scattering Legendre polynomials used for describing the phase function - Use 0 for extinction calculations only (e.g. transit, occultation)’ [Villanueva et al., 2022]

Type:

int

url#

URL of the Planetary Spectrum Generator.

Type:

str

api_key#

An instance of the APIkey class representing the PSG API key.

Type:

APIkey