Exo_k Logo
1.3.0
  • Getting exo_k
    • Installation using pip
    • Installing from the source files
    • Using the module
  • Basic principles and objects
    • Classes
  • Notes on units and formats
    • Keeping track of units
    • Available formats
    • Spectral units
    • Units in the forward model
  • Getting started
    • First steps with exo_k
      • Initialization
      • Documentation
    • Dealing with Ktable() objects
      • Loading and saving a Ktable() object
        • Loading a Ktable from a file
        • Managing Units
        • Setting up the search path and searching files using regular expressions
        • Writing a Ktable into a file
        • What is inside a Ktable object
        • Handling zeros
        • Copying a Ktable object
      • Plotting opacities and k-distributions
      • Interpolating and remapping tables
        • Basic interpolation
        • Interpolation options
        • (Log P, T) grid Remapping
        • Remapping in g-space
        • Extending the spectral range
        • Clipping data to a given spectral range
      • Binning down a Ktable
      • Rescaling and mixing Ktables
    • Dealing with mixes: The Kdatabase() object
      • Loading a Kdatabase() object
        • Global loading from files
        • Adding individual, already-loaded Ktables
        • Dealing with inhomogeneous databases
      • Accessing individual Ktables
      • Create a Ktable() for a mix of gases
      • Binning down a Kdatabase()
    • Loading and creating correlated-k tables to use with LMDZ GCM
      • Creating new corr-k for LMDZ-GCM
      • Loading existing LMDZ corr-k tables
      • Creating a LMDZ corr-k with a variable gas from a Kdatabase: the Ktable5d
      • Adding the opacity of a trace species to an existing corr-k table
    • Creating corr-k from High_resolution spectra
      • A note on ascii vs hdf5 data
      • Organizing your spectra into a grid
        • Kspectrum files generated for LMDZ
        • Files named with information on P, T (and x) in the title
      • Actually making the Ktable
      • Corr-k with a variable gas: Ktable5d
    • Dealing with cross sections: Xtable()objects
      • Xtable: sample or bin_down
      • Loading Xtable with kspectrum-like spectra
      • Creating a Ktable from an Xtable
    • Dealing with continua: Cia_table() and CIAdatabase() objects
    • How to use exo_k as an opacity interpolator inside your code: The Gas_mix object
      • Composition and background gas
      • Getting the molar mass
      • Connecting a gas with a radiative database
      • Choosing gas recombination method (when using Ktables)
  • Where to find data to use with Exo_k?
    • Cross sections and k-coefficient tables from the Exomol project
    • k-coefficient tables from ExoREM
    • k-coefficient tables from the LMDZ Generic GCM database
    • High-resolution cross sections from the petitRADTRANS database
    • Collision Induced Absorption (CIA)
  • A practical guide to atmospheric modeling with Exo_k
    • Modeling atmospheres and their evolution with exo_k: a practical guide
      • Initialization
    • The Atm class: An atmospheric radiative-transfer model
      • Loading the radiative data that we will use in our atmospheric model
        • Molecular absorptions: The Kdatabase
        • Collision induced absorptions
        • Rayleigh scattering
      • Building an atmosphere
        • Simple troposphere/stratosphere parametrization
        • Using your own profiles
        • Changing attributes of an atmosphere
        • Optional attributes
      • Transmission spectroscopy
      • Emission spectroscopy
        • Computing top of atmosphere fluxes
        • Turning CIAs on and off
        • Contribution Function
      • Adding reflected light
        • Using a stellar blackbody
        • Using an input stellar spectrum
        • Treating the stellar flux as a collimated flux
      • Heating rates
    • Modeling atmospheric evolution with Atm_evolution
      • Tailoring radiative data
      • Initializing an atmospheric evolution
      • Setting evolution options
      • Computing a time evolution
      • Plotting profiles
      • Acceleration
        • Using the radiative kernel
        • Other acceleration modes
      • Saving and loading an atmospheric model
      • Equilibrating an atmosphere
    • Tracers and condensing species
      • Putting tracers in your model
      • Tracer related options
      • Specifying initial tracer profiles and tracer sources
        • Setting up an ocean
        • Forcing surface concentration
  • Principles of atmospheric modeling with Exo_k
    • Basic structure of the atmosphere: the Atm class.
    • Radiative transfer
    • Time integration
    • Physical processes
      • Dry convective adjustment
      • Moist convective adjustment
      • Condensation
      • Rains
    • Numerical acceleration
      • Computation of the adaptive timestep
      • Using the Jacobian to compute fluxes.
    • Convergence acceleration
      • Acceleration in radiative zones
      • Acceleration in convective zones
    • References
  • Neat examples
    • Some worked out use-cases for exo_k
      • General initialization
      • Setting up global options for the library
    • Loading ExoMol files and changing their resolution before saving them in different formats
    • Creating k-coefficients for a new species not in ExoMol from high-resolution spectra from the petitRADTRANS database
    • Modelling transit spectra: sampled cross sections vs. k-coefficients (Leconte, A&A, 2020)
      • Create spectra on a different wavelength region
  • API reference
    • exo_k
      • Subpackages
        • exo_k.aerosol
        • exo_k.atm_evolution
        • exo_k.two_stream
        • exo_k.util
      • Submodules
        • exo_k.adatabase
        • exo_k.aerosols
        • exo_k.atable
        • exo_k.atm
        • exo_k.atm_2band
        • exo_k.atm_profile
        • exo_k.chemistry
        • exo_k.cia_table
        • exo_k.ciadatabase
        • exo_k.data_table
        • exo_k.fit
        • exo_k.gas_mix
        • exo_k.hires_spectrum
        • exo_k.kdatabase
        • exo_k.ktable
        • exo_k.ktable5d
        • exo_k.ktable_io
        • exo_k.rayleigh
        • exo_k.settings
        • exo_k.xtable
  • Index
  • How to contribute
    • Suggest improvements
    • What about your data format?
  • Development and documentation
    • Quickly use the source
    • Using Poetry
      • Documentation
      • Tests
      • Tests - Extensive
      • Poetry recap
      • CI/CD
Exo_k
  • API Reference
  • exo_k
  • View page source

exo_k

@author: jeremy leconte __init__ module to load the exo_k library

Subpackages

  • exo_k.aerosol
  • exo_k.atm_evolution
  • exo_k.two_stream
  • exo_k.util

Submodules

  • exo_k.adatabase
  • exo_k.aerosols
  • exo_k.atable
  • exo_k.atm
  • exo_k.atm_2band
  • exo_k.atm_profile
  • exo_k.chemistry
  • exo_k.cia_table
  • exo_k.ciadatabase
  • exo_k.data_table
  • exo_k.fit
  • exo_k.gas_mix
  • exo_k.hires_spectrum
  • exo_k.kdatabase
  • exo_k.ktable
  • exo_k.ktable5d
  • exo_k.ktable_io
  • exo_k.rayleigh
  • exo_k.settings
  • exo_k.xtable
Previous Next

© Copyright 2020, J. Leconte.

Built with Sphinx using a theme provided by Read the Docs.