Taurex API Documentation¶
- Core (
taurex.core) - Priors (
taurex.core.priors) - Binning Module (
taurex.binning)- Base Module
BinnedSpectrumTypeBinnedSpectrumType.binned_spectrumBinnedSpectrumType.binned_tauBinnedSpectrumType.binned_wlgridBinnedSpectrumType.binned_wlwidthBinnedSpectrumType.binned_wngridBinnedSpectrumType.binned_wnwidthBinnedSpectrumType.native_spectrumBinnedSpectrumType.native_tauBinnedSpectrumType.native_wlgridBinnedSpectrumType.native_wlwidthBinnedSpectrumType.native_wngridBinnedSpectrumType.native_wnwidth
Binner
- Flux-Binning
- Simple-Binning
- Lightcurve-Binning
- Native-Binning
- Base Module
- Caching Modules (
taurex.cache)- Singleton
- OpacityCache
OpacityCacheOpacityCache.add_opacity()OpacityCache.clear_cache()OpacityCache.enable_radis()OpacityCache.find_list_of_molecules()OpacityCache.force_active()OpacityCache.init()OpacityCache.load_opacity()OpacityCache.load_opacity_from_path()OpacityCache.set_interpolation()OpacityCache.set_memory_mode()OpacityCache.set_opacity_path()OpacityCache.set_radis_wavenumber()
- CIACache
- CIA (
taurex.cia) - Opacities (‘’taurex.opacity’’)
- Base
- Base Interpolator
InterpolatingOpacityInterpolatingOpacity.compute_opacity()InterpolatingOpacity.find_closest_index()InterpolatingOpacity.interp_bilinear_grid()InterpolatingOpacity.interp_pressure_only()InterpolatingOpacity.interp_temp_only()InterpolatingOpacity.logPressureInterpolatingOpacity.pressureBoundsInterpolatingOpacity.pressureMaxInterpolatingOpacity.pressureMinInterpolatingOpacity.set_interpolation_mode()InterpolatingOpacity.temperatureBoundsInterpolatingOpacity.temperatureMaxInterpolatingOpacity.temperatureMinInterpolatingOpacity.xsecGrid
- Pickle Format (
.pickle) - HDF5 Format (
.hdf5)HDF5OpacityHDF5Opacity.BIBTEX_ENTRIESHDF5Opacity.citations()HDF5Opacity.discover()HDF5Opacity.handle_pybtex()HDF5Opacity.moleculeNameHDF5Opacity.opacityCitation()HDF5Opacity.pressureGridHDF5Opacity.priority()HDF5Opacity.resolutionHDF5Opacity.temperatureGridHDF5Opacity.wavenumberGridHDF5Opacity.xsecGrid
- ExoTransmit Format (
.dat)
- Contributions (
taurex.contributions)- Base Contribution
- Absorption
- CIA
- Rayleigh
- SimpleClouds
- Mie Scattering (BH)
- Mie Scattering (Lee)
LeeMieContributionLeeMieContribution.BIBTEX_ENTRIESLeeMieContribution.contribute()LeeMieContribution.input_keywords()LeeMieContribution.mieBottomPressureLeeMieContribution.mieMixingLeeMieContribution.mieQLeeMieContribution.mieRadiusLeeMieContribution.mieTopPressureLeeMieContribution.prepare_each()LeeMieContribution.write()
- Mie Scattering (Flat)
- Chemistry Models (
taurex.chemistry)- Base
ChemistryChemistry.activeGasMixProfileChemistry.activeGasesChemistry.availableActiveChemistry.compute_mu_profile()Chemistry.condensateMixProfileChemistry.condensatesChemistry.gasesChemistry.get_condensate_mix_profile()Chemistry.get_gas_mix_profile()Chemistry.get_molecular_mass()Chemistry.hasCondensatesChemistry.inactiveGasMixProfileChemistry.inactiveGasesChemistry.initialize_chemistry()Chemistry.input_keywords()Chemistry.mixProfileChemistry.muChemistry.muProfileChemistry.set_star_planet()Chemistry.write()
- Base (Auto)
- Equilibrium Chemistry (ACE)
- Free chemistry
InvalidChemistryExceptionTaurexChemistryTaurexChemistry.addGas()TaurexChemistry.citations()TaurexChemistry.compute_elements_mix()TaurexChemistry.fill_atmosphere()TaurexChemistry.fitting_parameters()TaurexChemistry.gasesTaurexChemistry.get_element_ratio()TaurexChemistry.get_metallicity()TaurexChemistry.initialize_chemistry()TaurexChemistry.input_keywords()TaurexChemistry.isActive()TaurexChemistry.metallicityTaurexChemistry.mixProfileTaurexChemistry.setup_derived_params()TaurexChemistry.setup_fill_params()TaurexChemistry.write()
- Base
- Gas Models (
taurex.chemistry)- Base
- Constant
- Two Layer
TwoLayerGasTwoLayerGas.BIBTEX_ENTRIESTwoLayerGas.add_pressure_param()TwoLayerGas.add_surface_param()TwoLayerGas.add_top_param()TwoLayerGas.initialize_profile()TwoLayerGas.input_keywords()TwoLayerGas.mixProfileTwoLayerGas.mixRatioPressureTwoLayerGas.mixRatioSmoothingTwoLayerGas.mixRatioSurfaceTwoLayerGas.mixRatioTopTwoLayerGas.write()
- Array
TwoLayerGasTwoLayerGas.BIBTEX_ENTRIESTwoLayerGas.add_pressure_param()TwoLayerGas.add_surface_param()TwoLayerGas.add_top_param()TwoLayerGas.initialize_profile()TwoLayerGas.input_keywords()TwoLayerGas.mixProfileTwoLayerGas.mixRatioPressureTwoLayerGas.mixRatioSmoothingTwoLayerGas.mixRatioSurfaceTwoLayerGas.mixRatioTopTwoLayerGas.write()
- Temperature (
taurex.temperature) - Pressure Modules (
taurex.pressure) - Stellar Models (
taurex.stellar)- Base
- Blackbody
- PHOENIX
PhoenixStarPhoenixStar.BIBTEX_ENTRIESPhoenixStar.compute_logg()PhoenixStar.find_nearest_file()PhoenixStar.get_avail_phoenix()PhoenixStar.initialize()PhoenixStar.input_keywords()PhoenixStar.massPhoenixStar.read_spectra()PhoenixStar.recompute_spectra()PhoenixStar.spectralEmissionDensityPhoenixStar.temperaturePhoenixStar.write()
- Instruments (
taurex.instruments) - Observations (
taurex.spectrum)- Base
BaseSpectrumBaseSpectrum.binEdgesBaseSpectrum.binWidthsBaseSpectrum.create_binner()BaseSpectrum.derivedParametersBaseSpectrum.errorBarBaseSpectrum.fittingParametersBaseSpectrum.input_keywords()BaseSpectrum.rawDataBaseSpectrum.spectrumBaseSpectrum.wavelengthGridBaseSpectrum.wavenumberGridBaseSpectrum.write()
- Array
- Observed
- Iraclis
- Taurex
- Lightcurves
- Base
- Forward Models (
taurex.model)- Base
ForwardModelForwardModel.add_contribution()ForwardModel.build()ForwardModel.citations()ForwardModel.compute_error()ForwardModel.defaultBinner()ForwardModel.derivedParametersForwardModel.fittingParametersForwardModel.generate_profiles()ForwardModel.initialize_profiles()ForwardModel.input_keywords()ForwardModel.model()ForwardModel.model_contrib()ForwardModel.model_full_contrib()ForwardModel.write()
- Basic Model
OneDForwardModelSimpleForwardModelSimpleForwardModel.WARNSimpleForwardModel.altitudeProfileSimpleForwardModel.auto_grid()SimpleForwardModel.build()SimpleForwardModel.chemistrySimpleForwardModel.citations()SimpleForwardModel.collect_derived_parameters()SimpleForwardModel.collect_fitting_parameters()SimpleForwardModel.compute_error()SimpleForwardModel.densityProfileSimpleForwardModel.generate_profiles()SimpleForwardModel.initialize_profiles()SimpleForwardModel.model()SimpleForwardModel.model_contrib()SimpleForwardModel.model_full_contrib()SimpleForwardModel.nLayersSimpleForwardModel.nativeWavenumberGridSimpleForwardModel.path_integral()SimpleForwardModel.planetSimpleForwardModel.pressureSimpleForwardModel.pressureProfileSimpleForwardModel.set_native_grid()SimpleForwardModel.starSimpleForwardModel.temperatureSimpleForwardModel.temperatureProfileSimpleForwardModel.write()
- Transmission
- Emission
EmissionModelEmissionModel.albedotermEmissionModel.compute_final_flux()EmissionModel.evaluate_emission()EmissionModel.evaluate_emission_ktables()EmissionModel.input_keywords()EmissionModel.logBolometricFluxEmissionModel.partial_model()EmissionModel.path_integral()EmissionModel.set_num_gauss()EmissionModel.set_quadratures()EmissionModel.usingKTablesEmissionModel.write()
contribute_ktau_emission()contribute_ktau_emission_numba()contribute_ktau_emission_numpy()
- Direct Image
- Base
- Optimizers (
taurex.optimizer)- Base
DerivedParamFitParamFitParamOutputOptimizerOptimizer.chisq_trans()Optimizer.compile_params()Optimizer.compute_derived_trace()Optimizer.compute_fit()Optimizer.derived_latexOptimizer.derived_namesOptimizer.derived_parametersOptimizer.derived_valuesOptimizer.disable_derived()Optimizer.disable_fit()Optimizer.enable_derived()Optimizer.enable_fit()Optimizer.fit()Optimizer.fit_boundariesOptimizer.fit_latexOptimizer.fit_namesOptimizer.fit_valuesOptimizer.fit_values_nomodeOptimizer.fitting_parametersOptimizer.fitting_priorsOptimizer.generate_profiles()Optimizer.generate_solution()Optimizer.get_samples()Optimizer.get_solution()Optimizer.get_weights()Optimizer.input_keywords()Optimizer.log_likelihood()Optimizer.prior_transform()Optimizer.sample_parameters()Optimizer.set_boundary()Optimizer.set_factor_boundary()Optimizer.set_mode()Optimizer.set_model()Optimizer.set_observed()Optimizer.set_prior()Optimizer.update_model()Optimizer.write()Optimizer.write_fit()Optimizer.write_optimizer()
compile_params()
- Nestle (
taurex.optimizer.nestle)NestleOptimizerNestleOptimizer.BIBTEX_ENTRIESNestleOptimizer.compute_fit()NestleOptimizer.get_samples()NestleOptimizer.get_solution()NestleOptimizer.get_weights()NestleOptimizer.input_keywords()NestleOptimizer.numLivePointsNestleOptimizer.store_nestle_output()NestleOptimizer.toleranceNestleOptimizer.write_fit()NestleOptimizer.write_optimizer()
NestleSolutionOutputNestleStatsOutput
- MultiNest (
taurex.optimizer.multinest)MultiNestOptimizerMultiNestOptimizer.BIBTEX_ENTRIESMultiNestOptimizer.compute_fit()MultiNestOptimizer.generate_solution()MultiNestOptimizer.get_samples()MultiNestOptimizer.get_solution()MultiNestOptimizer.get_weights()MultiNestOptimizer.input_keywords()MultiNestOptimizer.store_nest_solutions()MultiNestOptimizer.write_fit()MultiNestOptimizer.write_optimizer()
NestFitParamNestMarginalOutputNestModeStatsOutputNestOutputTypeNestSolutionOutputNestStatsOutput
- PolyChord (
taurex.optimizer.polychord) - dyPolyChord (
taurex.optimizer.dypolychord)
- Base
- Logging (
taurex.log) - Outputs (
taurex.output) - Utilities
- Submodules
- taurex.util.emission module
- taurex.util.math module
- taurex.util.util module
bindown()calculate_weight()class_for_name()class_from_keyword()clip_native_to_wngrid()compute_bin_edges()compute_dz()conversion_factor()create_grid_res()decode_string_array()ensure_string_utf8()find_closest_pair()get_molecular_weight()has_duplicates()loadtxt2d()merge_elements()molecule_texlabel()movingaverage()quantile_corner()random_int_iter()read_error_into_dict()read_error_line()read_table()recursively_save_dict_contents_to_output()sanitize_molecule_string()split_molecule_elements()store_thing()tokenize_molecule()weighted_avg_and_std()wnwidth_to_wlwidth()
- Module contents
bindown()calculate_weight()class_for_name()class_from_keyword()clip_native_to_wngrid()compute_bin_edges()compute_dz()conversion_factor()create_grid_res()decode_string_array()ensure_string_utf8()find_closest_pair()get_molecular_weight()has_duplicates()loadtxt2d()merge_elements()molecule_texlabel()movingaverage()quantile_corner()random_int_iter()read_error_into_dict()read_error_line()read_table()recursively_save_dict_contents_to_output()sanitize_molecule_string()split_molecule_elements()store_thing()tokenize_molecule()weighted_avg_and_std()wnwidth_to_wlwidth()
- taurex.parameter package
- Submodules
- taurex.parameter.factory module
ConfigTypecreate_chemistry()create_generic()create_instrument()create_klass()create_model()create_observation()create_optimizer()create_planet()create_pressure_profile()create_prior()create_spectrum()create_star()create_temperature_profile()detect_and_return_klass()determine_klass()generate_contributions()generic_factory()get_keywordarg_dict()
- taurex.parameter.parameterparser module
ParameterParserParameterParser.create_manual_binning()ParameterParser.create_snr()ParameterParser.generate_appropriate_model()ParameterParser.generate_binning()ParameterParser.generate_chemistry_profile()ParameterParser.generate_derived_parameters()ParameterParser.generate_fitting_parameters()ParameterParser.generate_instrument()ParameterParser.generate_lightcurve()ParameterParser.generate_model()ParameterParser.generate_observation()ParameterParser.generate_optimizer()ParameterParser.generate_planet()ParameterParser.generate_pressure_profile()ParameterParser.generate_star()ParameterParser.generate_temperature_profile()ParameterParser.read()ParameterParser.setup_globals()ParameterParser.setup_optimizer()ParameterParser.transform()
- Module contents
ParameterParserParameterParser.create_manual_binning()ParameterParser.create_snr()ParameterParser.generate_appropriate_model()ParameterParser.generate_binning()ParameterParser.generate_chemistry_profile()ParameterParser.generate_derived_parameters()ParameterParser.generate_fitting_parameters()ParameterParser.generate_instrument()ParameterParser.generate_lightcurve()ParameterParser.generate_model()ParameterParser.generate_observation()ParameterParser.generate_optimizer()ParameterParser.generate_planet()ParameterParser.generate_pressure_profile()ParameterParser.generate_star()ParameterParser.generate_temperature_profile()ParameterParser.read()ParameterParser.setup_globals()ParameterParser.setup_optimizer()ParameterParser.transform()
- Mixin (
taurex.mixin)AnyMixinChemistryMixinContributionMixinForwardModelMixinGasMixinInstrumentMixinMixinMixinProtocolObservationMixinOptimizerMixinPlanetMixinPressureMixinSpectrumMixinStarMixinTemperatureMixinbuild_new_mixed_class()determine_mixin_args()enhance_class()find_mapped_mixin()mixed_init()MakeFreeMixinMakeFreeMixin.activeGasMixProfileMakeFreeMixin.activeGasesMakeFreeMixin.addGas()MakeFreeMixin.compute_mu_profile()MakeFreeMixin.determine_new_mix_mask()MakeFreeMixin.fitting_parameters()MakeFreeMixin.gasesMakeFreeMixin.inactiveGasMixProfileMakeFreeMixin.inactiveGasesMakeFreeMixin.initialize_chemistry()MakeFreeMixin.input_keywords()MakeFreeMixin.muProfile
TempScaler
- MPI (
taurex.mpi)