ObservationModel

class VSPEC.ObservationModel(params: InternalParameters)

Bases: object

Main class that stores the information of this simulation.

Parameters:

params (VSPEC.params.InternalParameters) – The global parameters describing the VSPEC simulation.

Examples

>>> model = ObservationModel.from_yaml('config.yaml')
>>> model.build_planet()
Build Planet: 100%|██████████| 26/26 [00:02<00:00,  8.68it/s]
>>> model.build_spectra()
Build Spectra: 100%|██████████| 26/26 [00:15<00:00,  1.66it/s]

>>> model = ObservationModel(params=my_params)
>>> model.build_planet()
Build Planet: 100%|██████████| 18/18 [00:07<00:00,  2.62it/s]
>>> model.build_spectra()
Build Spectra: 100%|██████████| 18/18 [02:35<00:00,  8.65s/it]

Attributes Summary

directories

The directory structure for the VSPEC run.

Methods Summary

build_planet()	Use the PSG GlobES API to construct a planetary phase curve.
build_spectra()	Integrate our stellar model with PSG to produce a variable host + planet simulation.
from_yaml(config_path)	Initialize a VSPEC run from a YAML file.
get_observation_parameters()	Get an object to store and compute the geometric observational parameters for this simulation.

Attributes Documentation

directories

The directory structure for the VSPEC run.

Returns:

Keys represent the identifiers of directories, and the values are pathlib.Path objects.

Return type:

dict

Methods Documentation

build_planet()

Use the PSG GlobES API to construct a planetary phase curve. Follow steps in original PlanetBuilder.py file

Examples

>>> model = ObservationModel.from_yaml(CFG_PATH)
>>> model.build_planet()
Build Planet: 100%|██████████| 36/36 [00:07<00:00,  4.60it/s]

build_spectra()

Integrate our stellar model with PSG to produce a variable host + planet simulation. Follow the original Build_Spectra.py file to construct phase curve outputs.

Examples

>>> model = ObservationModel.from_yaml(CFG_PATH) # build_planet() has been run previously
>>> model.build_spectra()
Build Spectra: 100%|██████████| 36/36 [00:23<00:00,  1.53it/s]

classmethod from_yaml(config_path: Path)

Initialize a VSPEC run from a YAML file.

Parameters:

config_path (pathlib.Path) – The path to the YAML file.

get_observation_parameters() → SystemGeometry

Get an object to store and compute the geometric observational parameters for this simulation.

Returns:

An bbject storing the geometric observation parameters of this simulation.

Return type:

VSPEC.geometry.SystemGeometry