Retrieval Examples

In this section we will give fully implemented examples of retrievals.

If you use the pRT retrieval package, please cite Nasedkin et al. (2024).

The retrieval tutorials use the current dataset-control names scale_flux, scale_uncertainties, and fit_flux_offset. They also demonstrate the JAX retrieval setup through the same Data and RetrievalConfig interfaces.

• Retrieval Parameter Reference
  • Overview of Built-in Model Functions
  • Planetary / Orbital Parameters
  • Temperature–Pressure Profile Parameters
  • Chemistry Parameters
  • Cloud Parameters
  • Optional Emission Model Parameters
  • Per-Dataset Instrumental / Calibration Parameters
  • Gaussian-Process Covariance Hyperparameters
  • Uncertainties Mode Parameters
  • Parameter Compatibility Matrix
  • Prior Types for RetrievalParameter
  • Internal Infrastructure Parameters
  • Example: Minimal Emission Retrieval Setup
• Retrieval Samplers
  • Choosing a sampler
  • Backend-specific parameters
  • Defining a custom sampler
  • Practical guidance
• Retrievals: Basic Retrieval Tutorial
  • Getting started
  • Opacities
  • Model Functions
  • Data
  • Plotting
  • Running the retrieval
• Retrievals: Advanced features
  • Getting started
  • Photometric data
  • Parameters and Priors
  • Free cloud parameterisation
• Retrievals with JAX
  • Before you start
  • A true runtime-native model
  • Retrieval configuration
  • Running JAXNS
  • Notes
• Retrievals: JAX Emission Tutorial
  • Before you start
  • Retrieval configuration
  • Running JAXNS
  • Notes
• Retrievals: Using the Model Functions
  • The ModelContext and PhysicalParams objects
  • Emission spectrum: spline_eddington_adiabatic_emission
  • Other emission models
  • Transmission spectrum: guillot_transmission
  • Writing a custom model
  • Using the model in a retrieval
• Retrievals: Dealing with multiple datasets
  • Getting started
  • External references
  • Model parameters
  • Opacities
  • Plotting
  • Running the retrieval
  • Post processing
• Retrievals: Emission Spectra Retrieval
  • Getting started
  • Photometric data
  • Parameters and Priors
• Retrievals: Emission Spectra Retrieval with NumPyro NUTS
  • Getting started
  • Photometric data
  • Parameters and Priors
• Leave-One-Out Analysis with petitRADTRANS 4
  • Runtime-native model function
  • Retrieval configuration helper
  • Running the Dynesty retrievals
  • Loading posterior samples
  • Computing leave-one-out diagnostics
  • Plotting the best-fit spectrum
• JWST retrieval workflow with SpectralModel
  • Loading data
  • Optional: loading a Planet
  • Initializing the forward model
  • Defining the retrieved parameters
  • Setting up the retrieval
  • Running the retrieval
  • Plotting a corner plot
  • Best fit model and best fit parameters
  • Retrieval with multiple datasets
• High-resolution retrieval workflow with SpectralModel
  • Optional: loading a Planet
  • Loading data
  • Optional: generating simulated observations
  • Preparing the data
  • Defining the retrieved parameters
  • The forward model: a SpectralModel with velocity range
  • Setting up the retrieval
  • Running the retrieval
  • Plotting a corner plot
  • Best fit model and best fit parameters
• Retrievals: Exploring the built-in models
  • Emission spectrum models
  • Transmission spectrum models