Skip to main content
Ctrl+K
VSPEC 1.0.0 documentation - Home VSPEC 1.0.0 documentation - Home
  • Introduction
  • Getting Started
  • VSPEC API
  • Inputs
  • References
    • End-to-End Examples
    • Other Examples
  • Introduction
  • Getting Started
  • VSPEC API
  • Inputs
  • References
  • End-to-End Examples
  • Other Examples
  • Inputs
  • Header

Header#

class VSPEC.params.Header(data_path: Path, spec_grid: AbstractGridParameters, 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

previous

GravityParameters

next

InstrumentParameters

On this page
  • Header
    • Header.data_path
    • Header.max_teff
    • Header.min_teff
    • Header.seed
    • Header.verbose
    • Header.desc
Show Source

© Copyright 2024, The VSPEC Collaboration.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.0.