taurex.parameter package

Submodules

taurex.parameter.factory module

class ConfigType

Bases: TypedDict

Input section.

profile_type: str | None

python_file: str | None

type: str | None

create_chemistry(config: ConfigType) → Chemistry

Chemistry as a special case.

create_generic(config: ConfigType, baseclass: Type[InputT], default_type: str | None = None, alt_type: str | Sequence[str] | None = None) → InputT

Create a generic class from input.

create_instrument(config: ~taurex.parameter.factory.ConfigType, *, baseclass: ~typing.Type[~taurex.parameter.factory.InputT] = <class 'taurex.instruments.instrument.Instrument'>, default_type: str | None = None, alt_type: str | ~typing.Sequence[str] | None = 'instrument') → InputT

Create a generic class from input.

create_klass(config: ConfigType, klass: Type[T]) → T

Create a class from a dictionary.

create_model(config: ConfigType, gas: Chemistry, temperature: TemperatureProfile, pressure: PressureProfile, planet: Planet, star: Star, observation: BaseSpectrum | None = None) → ForwardModel

Create a forward model from input.

create_observation(config: ~taurex.parameter.factory.ConfigType, *, baseclass: ~typing.Type[~taurex.parameter.factory.InputT] = <class 'taurex.data.spectrum.spectrum.BaseSpectrum'>, default_type: str | None = None, alt_type: str | ~typing.Sequence[str] | None = 'observation') → InputT

Create a generic class from input.

create_optimizer(config: ~taurex.parameter.factory.ConfigType, *, baseclass: ~typing.Type[~taurex.parameter.factory.InputT] = <class 'taurex.optimizer.optimizer.Optimizer'>, default_type: str | None = None, alt_type: str | ~typing.Sequence[str] | None = 'optimizer') → InputT

Create a generic class from input.

create_planet(config: ~taurex.parameter.factory.ConfigType, *, baseclass: ~typing.Type[~taurex.parameter.factory.InputT] = <class 'taurex.data.planet.Planet'>, default_type: str | None = 'simple', alt_type: str | ~typing.Sequence[str] | None = 'planet_type') → InputT

Create a generic class from input.

create_pressure_profile(config: ~taurex.parameter.factory.ConfigType, *, baseclass: ~typing.Type[~taurex.parameter.factory.InputT] = <class 'taurex.data.profiles.pressure.pressureprofile.PressureProfile'>, default_type: str | None = None, alt_type: str | ~typing.Sequence[str] | None = None) → InputT

Create a generic class from input.

create_prior(prior: str) → Prior

create_spectrum(config: ~taurex.parameter.factory.ConfigType, *, baseclass: ~typing.Type[~taurex.parameter.factory.InputT] = <class 'taurex.data.spectrum.spectrum.BaseSpectrum'>, default_type: str | None = None, alt_type: str | ~typing.Sequence[str] | None = 'observation') → InputT

Create a generic class from input.

create_star(config: ~taurex.parameter.factory.ConfigType, *, baseclass: ~typing.Type[~taurex.parameter.factory.InputT] = <class 'taurex.data.stellar.star.Star'>, default_type: str | None = None, alt_type: str | ~typing.Sequence[str] | None = 'star_type') → InputT

Create a generic class from input.

create_temperature_profile(config: ~taurex.parameter.factory.ConfigType, *, baseclass: ~typing.Type[~taurex.parameter.factory.InputT] = <class 'taurex.data.profiles.temperature.tprofile.TemperatureProfile'>, default_type: str | None = None, alt_type: str | ~typing.Sequence[str] | None = None) → InputT

Create a generic class from input.

detect_and_return_klass(python_file: str | bytes | PathLike | Path, baseclass: Type[InputT]) → Type[InputT]

Detect and return class from python file.

determine_klass(config: ConfigType, baseclass: Type[InputT], default_type: str | None = None, alt_type: str | Sequence[str] | None = None) → Tuple[ConfigType, Type[InputT], bool]

Determine class from input.

generate_contributions(config: ConfigType) → List[Contribution]

Generate contributions from input.

generic_factory(profile_type: str, baseclass: Type[InputT]) → Type[InputT]

Get a class from input_keyword string.

get_keywordarg_dict(klass: Type[T]) → Tuple[Dict[str, Any], bool]

Get all keyword arguments for a class.

taurex.parameter.parameterparser module

class ParameterParser

Bases: Loggable

Parse input file and generate appropriate objects.

create_manual_binning(config)

create_snr(binner, config)

Create SNR instrument.

generate_appropriate_model(obs=None)

Generate appropriate model from input file.

generate_binning()

generate_chemistry_profile()

generate_derived_parameters()

generate_fitting_parameters()

generate_instrument(binner=None)

Generate instrument from input file.

generate_lightcurve()

Generate lightcurve model from input file.

generate_model(chemistry=None, pressure=None, temperature=None, planet=None, star=None, obs=None)

generate_observation()

Generate observation from input file.

generate_optimizer()

Generate optimizer from input file.

generate_planet()

generate_pressure_profile()

generate_star()

generate_temperature_profile()

read(filename: str | bytes | PathLike | Path) → None

Read input file into a dictionary and transform.

setup_globals()

Setup global cache from input file.

setup_optimizer(optimizer: Optimizer)

Setup fitting parameters for optimizer.

transform(section: Dict[str, Any], key: str) → Any

Transform string arguments to appropriate types.

Module contents

Related to parameter parsing and loading taurex.

class ParameterParser

Bases: Loggable

Parse input file and generate appropriate objects.

create_manual_binning(config)

create_snr(binner, config)

Create SNR instrument.

generate_appropriate_model(obs=None)

Generate appropriate model from input file.

generate_binning()

generate_chemistry_profile()

generate_derived_parameters()

generate_fitting_parameters()

generate_instrument(binner=None)

Generate instrument from input file.

generate_lightcurve()

Generate lightcurve model from input file.

generate_model(chemistry=None, pressure=None, temperature=None, planet=None, star=None, obs=None)

generate_observation()

Generate observation from input file.

generate_optimizer()

Generate optimizer from input file.

generate_planet()

generate_pressure_profile()

generate_star()

generate_temperature_profile()

read(filename: str | bytes | PathLike | Path) → None

Read input file into a dictionary and transform.

setup_globals()

Setup global cache from input file.

setup_optimizer(optimizer: Optimizer)

Setup fitting parameters for optimizer.

transform(section: Dict[str, Any], key: str) → Any

Transform string arguments to appropriate types.