Contents Menu Expand Light mode Dark mode Auto light/dark mode
VSPEC 0.5.0 documentation
Logo
VSPEC 0.5.0 documentation

Contents:

  • Introduction
  • Getting Started
  • VSPEC Modules
    • VSPEC.main
      • ObservationModel
    • VSPEC.geometry
      • SystemGeometry
    • VSPEC.spectra
      • ForwardSpectra
    • VSPEC.psg_api
      • cfg_to_bytes
      • cfg_to_dict
      • change_psg_parameters
      • get_reflected
    • VSPEC.analysis
      • PhaseAnalyzer
    • VSPEC.helpers
      • arrange_teff
      • check_and_build_dir
      • clip_teff
      • get_filename
      • get_planet_indicies
      • get_surrounding_teffs
      • isclose
      • round_teff
    • VSPEC.gcm
      • TemperatureMap
      • get_flux
      • get_psi
      • pcos
      • colat
      • get_t0
      • get_equator_curve
      • energy_balance_error
    • VSPEC.config
      • BINNED_PHOENIX_PATH
      • EXAMPLE_GCM_PATH
      • MOLEC_DATA_PATH
      • MSH
      • N_ZFILL
      • PRESET_PATH
      • PSG_CFG_MAX_LINES
      • PSG_EXT_URL
      • PSG_PORT
      • RAW_PHOENIX_PATH
      • VSPEC_PARENT_PATH
      • aerosol_name_dict
      • aerosol_type_dict
      • atmosphere_type_dict
      • flux_unit
      • grid_teff_bounds
      • nlat
      • nlon
      • period_unit
      • planet_distance_unit
      • planet_radius_unit
      • psg_aerosol_size_unit
      • psg_encoding
      • psg_pressure_unit
      • starspot_initial_area
      • stellar_area_unit
      • teff_unit
      • wl_unit
    • VSPEC.builtins
      • download_waccm_test_data
      • WACCM_PATH
  • Input Parameters
    • InternalParameters
    • Header
    • StarParameters
    • SpotParameters
    • FaculaParameters
    • FlareParameters
    • GranulationParameters
    • LimbDarkeningParameters
    • PlanetParameters
    • GravityParameters
    • SystemParameters
    • gcmParameters
    • psgParameters
    • ObservationParameters
    • InstrumentParameters
    • TelescopeParameters
    • SingleDishParameters
    • CoronagraphParameters
    • BandpassParameters
    • DetectorParameters
    • ccdParameters
    • PSGtable
    • parse_table
    • BaseParameters
  • References
  • End-to-End Examples
    • Plot the spectrum of a transiting planet
    • Make a phase curve GIF
    • Observe the MIRECLE Phase Curve of Proxima Centauri b
    • Observe a phase curve of a spotted star.
    • Observe a transit of a spotted star.
  • Other Examples
    • GCM Examples
      • Compare to Cowan & Agol (2011)
    • VSPEC Star Examples
      • Plot the lightcurve of a spotted star
      • Plot the lightcurve stellar granulation
      • Plot the lightcurve of a flaring star
      • Plot the lightcurve of a star with faculae
      • Plot the lightcurve of a flaring star with spots
Back to top

Header#

class VSPEC.params.read.Header(data_path: Path, teff_min: astropy.units.Quantity, teff_max: astropy.units.Quantity, seed: int, verbose: int = 1, desc: str = None)#

Bases: BaseParameters

Header for VSPEC simulation

Parameters:
  • data_path (pathlib.Path) – The path to store run data.

  • max_teff (astropy.units.Quantity) – The maximum Teff to bin.

  • min_teff (astropy.units.Quantity) – The minimum Teff to bin.

  • seed (int, default=None) – The seed for the random number generator.

  • verbose (int, default=1,) – The level of verbosity for the simulation.

  • desc (str, default=None) – A description of the run.

data_path#

The path to store run data.

Type:

pathlib.Path

max_teff#

The maximum Teff to bin.

Type:

astropy.units.Quantity

min_teff#

The minimum Teff to bin.

Type:

astropy.units.Quantity

seed#

The seed for the random number generator.

Type:

int or None

verbose#

The level of verbosity for the simulation.

Type:

int

desc#

A description of the run.

Type:

str or None

Next
StarParameters
Previous
InternalParameters
Copyright © 2024, The VSPEC Collaboration
Made with Sphinx and @pradyunsg's Furo
On this page
  • Header
    • Header
      • Header.data_path
      • Header.max_teff
      • Header.min_teff
      • Header.seed
      • Header.verbose
      • Header.desc