BeAR Documentation

Welcome to BeAR!

On this page you find the documentation for BeAR, the Bern Atmospheric Retrieval code. If you find any new errors or inaccuracies, please send them to daniel.kitzmann@unibe.ch .

• Overview
• Licence
• Installation
  • Obtaining the code
  • Prerequisites
  • Configuration and compilation of BeAR with CMake
  • Configuration and compilation of pyBeAR with CMake
• Opacity data
  • Global wavenumber grid
  • Opacity data for a specific species
    • Special cases
  • Opacities included in BeAR
  • Choosing opacity sources in forward models
• Observations
  • Supported observational types
  • Spectroscopy
    • Input file structure
  • Band Spectroscopy
    • Input file structure
  • Photometry
    • Input file structure
  • Instrument Line Profile
  • Filter transmission function
    • Input file structure
    • Observational data file
• Forward Models
  • Model postprocessing
  • Flat line
    • Model config file
    • Model postprocessing
  • Transmission spectrum
    • Model config file
    • Model postprocessing
  • Secondary eclipse spectrum
    • Model config file
    • Model postprocessing
  • Secondary eclipse spectrum with planetary blackbody
    • Model config file
    • Model postprocessing
  • Emission spectrum
    • Model config file
    • Model postprocessing
• Prior distributions
  • Prior distributions units
  • Prior distributions file
  • Order of prior distributions
• Setting up and starting a retrieval
  • Configuration files
    • Main retrieval file
    • Forward model configuration file
    • Prior distributions file
    • Observational data file
    • Postprocess configuration file
  • Output files
• The pyBeAR package
  • Starting a simple pyBeAR retrieval
  • Advanced pyBeAR retrieval calculations
  • Calling forward models directly
    • Transmission Spectrum Forward Model
    • Secondary Eclipse Spectrum Forward Model
    • Emission Spectrum Forward Model
• Temperature profiles
  • Milne’s solution
  • Guillot profile
  • Isoprofiles
  • Piecewise polynomials
  • Cubic b splines
• Chemistry Models
  • Isoprofiles
  • Isoprofiles with centred-log-ratio priors
  • Piecewise polynomials
  • Cubic b splines
  • Equilibrium chemistry
  • Background species
  • Mixing different chemistry models
  • Chemical species list
• Cloud Models
  • Grey Cloud Model
  • Kitzmann & Heng Non-Grey Cloud Model
  • Power-Law Cloud Model
  • Mixing different cloud models
• Stellar spectra
  • Blackbody spectra
  • Tabulated stellar spectrum
  • Grid of tabulated stellar spectra
• Parametrisations of vertical profiles
  • Isoprofiles
  • Piecewise polynomials
  • Cubic b splines
• Detailed Description of pyBeAR
  • Retrieval and PostProcess classes
    • pybear.Retrieval class
    • pybear.PostProcess class
  • pybear.Config
  • pybear.SpectralGrid
  • pybear.Observation
  • pybear.Prior
  • pybear.ForwardModelOutput
  • pybear.AtmosphereOutput
  • Transmission Spectrum
    • Model Config
    • PostProcess Config
  • Secondary Eclipse Spectrum
    • Model Config
    • PostProcess Config
  • Secondary Eclipse Spectrum with Planetary Blackbody
    • Model Config
    • PostProcess Config
  • Emission Spectrum
    • Model Config
    • PostProcess Config