Exo_k Logo
  • 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)
    • The Atmclass: An integrated atmospheric radiative-transfer model
      • Emission
      • Emission with continuum and your own thermal profile
      • Transmission
      • Heating rates
  • 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)
  • 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)
  • API reference
    • exo_k
      • Subpackages
        • exo_k.util
      • Submodules
        • exo_k.adatabase
        • exo_k.atable
        • exo_k.atm
        • exo_k.chemistry
        • exo_k.cia_table
        • exo_k.ciadatabase
        • exo_k.data_table
        • 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
      • Package Contents
        • Ktable
        • Ktable5d
        • Xtable
        • Hires_spectrum
        • PI
        • create_table
        • hires_to_ktable
        • hires_to_xtable
        • convert_kspectrum_to_hdf5
        • create_fname_grid
        • finalize_LMDZ_dir
        • mmr_to_number_density
        • PI
        • PLANCK
        • C_LUM
        • KBOLTZ
        • SIG_SB
        • PLANCK_CST1MKS
        • PLANCK_CST1
        • PLANCK_CST2
        • PLANCK_CST1_lamb
        • Bnu
        • Bnu_integral
        • Bnu_integral_num
        • Bnu_integral_array
        • Bnu_integral_old
        • Bmicron
        • BBnu_Stellar_Spectrum
        • BBmicron_Stellar_Spectrum
        • wavelength_grid_R
        • wavenumber_grid_R
        • rad_prop_corrk
        • rad_prop_xsec
        • path_integral_corrk
        • path_integral_xsec
        • gauss_legendre
        • split_gauss_legendre
        • G
        • RSOL
        • RJUP
        • RJUP_POL
        • PI
        • MSOL
        • MJUP
        • AU
        • KBOLTZ
        • RGP
        • PLANCK
        • C_LUM
        • SIG_SB
        • N_A
        • tiny
        • OneMintiny
        • ktable_long_name_attributes
        • nemesis_hitran_id_numbers
        • Spectrum
        • EndOfFile
        • select_kwargs
        • create_fname_grid_Kspectrum_LMDZ
        • convert_exo_transmit_to_hdf5
        • convert_old_kspectrum_to_hdf5
        • Molar_mass
        • Ktable
        • Ktable5d
        • Kdatabase
        • Xtable
        • Atable
        • combine_tables
        • Adatabase
        • Cia_table
        • CIAdatabase
        • Hires_spectrum
        • Atm_profile
        • Atm
        • EquChemTable
        • Gas_mix
        • Settings
        • Rayleigh
  • Looking for a function? (Index)
  • How to contribute
    • Suggest improvements
    • What about your data format?
  • Building the documentation
Exo_k
  • Docs »
  • API Reference
  • View page source

API Reference¶

This page contains auto-generated API reference documentation 1.

  • exo_k
    • exo_k.util
      • exo_k.util.cst
      • exo_k.util.filenames
      • exo_k.util.interp
      • exo_k.util.molar_mass
      • exo_k.util.radiation
      • exo_k.util.singleton
      • exo_k.util.spectral_object
      • exo_k.util.spectrum
      • exo_k.util.user_func
    • exo_k.adatabase
    • exo_k.atable
    • exo_k.atm
    • exo_k.chemistry
    • exo_k.cia_table
    • exo_k.ciadatabase
    • exo_k.data_table
    • 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
1

Created with sphinx-autoapi

Next Previous

© Copyright 2020, J. Leconte

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