# Exo_k
Author: Jeremy Leconte (CNRS/LAB/Univ. Bordeaux)
`Exo_k` is a Python 3 based library to handle radiative opacities from various sources for atmospheric applications.
It now comes with a full-fledged 1D atmospheric evolution model.
It enables you to:
* Interpolate efficiently and easily in correlated-k and cross section tables.
* Convert easily correlated-k and cross section tables from one format to another
(hdf5, LMDZ GCM, Exomol, Nemesis, PetitCode, TauREx, ExoREM, ARCIS, etc.).
* Adapt precomputed correlated-k tables to your needs by changing:
* the spectral and quadrature (g) grids,
* the pressure/temperature grid.
* Create tables for a mix of gases using tables for individual gases.
* Create your own tables from high-resolution spectra (for example from K-spectrum, Helios-K, etc.).
* Use your data in an integrated radiative transfer framework to simulate planetary atmospheres.
* Compute the physical state of planetary atmospheres in radiative-convective equilibrium.
For a complete online documentation, checkout:
http://perso.astrophy.u-bordeaux.fr/~jleconte/exo_k-doc/index.html
In this repository, you'll find a [tutorial jupyter notebook](https://forge.oasu.u-bordeaux.fr/jleconte/exo_k-public/-/blob/public/tutorials/tutorial-exo_k.ipynb) that will show you how to do all that
with concrete examples that you can run on your own machine. Many important concepts and options are
presented along the way.
Enjoy!
J. Leconte
# Acknowledgements
If you use this library in your research, please acknowledge it by citing
[Leconte (2021)](https://ui.adsabs.harvard.edu/abs/2021A%26A...645A..20L/abstract):
* Spectral binning of precomputed correlated-k coefficients. **Astronomy and Astrophysics** 645. Leconte, J. 2021. doi:10.1051/0004-6361/202039040
This project has received funding from the European Research Council (ERC)
under the European Union's Horizon 2020 research and innovation programme
(grant agreement n° 679030/WHIPLASH).
The framework for this documentation has been developped by Aurelien Falco using Sphinx.
The Framework for automatic testing has been developped by Alexandre Mechineau.
# last release (see past releases below)
v1.2.2 (September 2023): Improvement have been made on the development side. We added a conda environment allowing
to easily contribute to `Exo_k`. Dependencies have been updated.
# Installation
Exo_k can be installed using pip (without cloning the repository;
dependencies should be downloaded automatically):
```shell
pip install exo_k
```
# Usage
To learn how to use `exo_k`, you can follow the [tutorial jupyter notebook](https://forge.oasu.u-bordeaux.fr/jleconte/exo_k-public/-/blob/public/tutorial-exo_k.ipynb).
Have fun!
# Links
* Project homepage: http://perso.astrophy.u-bordeaux.fr/~jleconte/
* Code repository: https://forge.oasu.u-bordeaux.fr/jleconte/exo_k-public
* Documentation: http://perso.astrophy.u-bordeaux.fr/~jleconte/exo_k-doc/index.html
* Contact: jeremy.leconte at u-bordeaux.fr
# past releases
v1.2.1 (June 2023): Fixes some minor bugs in the atmospheric evolution module.
Addition of a contribution function in the atmospheric radiative transfer module.
See the atmosphere tutorial for an example.
v1.2.0 (July 2022): The model for atmospheric evolution is finally stable and documented.
The atm module has also seen several note worthy additions: surface albedo, oceans.
We also added a framework for an automatic test suite. In particular, we can test several python versions. Additional tests should rapidly come along.
Rosseland and Planck mean opacities can now be computed from radiative tables.
v1.1.0 (August 2021): New scheme for the computation of atmospheric emission/transmission
to ensure an improved numerical accuracy. The variable names to instantiate atm objects have
changed accordingly (see tutorial).
v1.0.2 (June 2021): Adds a few missing dependencies. Enables computation of thermal
emission spectra with scattering through the two-stream method (full documentation pending).
Enables creating Xtables for a mix of gases (CIA can be added as well). Solves some issues
with the 2018 Hitran CIA format.
v1.0.1 (Jan 2021): Solves a binary/string conversion issue introduced by version 3 of h5py.
Enables linear interpolation in pressure (default is log). Enables creation of
empty tables to be filled later and extension of the spectral range of existing tables.
v1.0.0 (Dec 2020): Finally our first official version. Creation of a
'examples' notebook with fully worked out use cases for the `Exo_k`.
v0.0.5 (Oct 2020): Ensures compatibility with latest Exomol correlated-k and cross-section tables.
Raw data
{
"_id": null,
"home_page": "https://forge.oasu.u-bordeaux.fr/jleconte/exo_k-public",
"name": "Exo-k",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "opacities,cross sections,correlated-k,spectra,atmosphere,atmospheric,exoplanet,radiative transfer",
"author": "Jeremy Leconte",
"author_email": "jeremy.leconte@u-bordeaux.fr",
"download_url": "https://files.pythonhosted.org/packages/16/a1/f436f3f1287e4e3821730171896bdc2fe9d912dcbc4aab3e834bb9e16969/exo_k-1.2.2.tar.gz",
"platform": null,
"description": "# Exo_k\n\nAuthor: Jeremy Leconte (CNRS/LAB/Univ. Bordeaux)\n\n`Exo_k` is a Python 3 based library to handle radiative opacities from various sources for atmospheric applications.\nIt now comes with a full-fledged 1D atmospheric evolution model.\n\nIt enables you to:\n\n* Interpolate efficiently and easily in correlated-k and cross section tables.\n* Convert easily correlated-k and cross section tables from one format to another\n (hdf5, LMDZ GCM, Exomol, Nemesis, PetitCode, TauREx, ExoREM, ARCIS, etc.).\n* Adapt precomputed correlated-k tables to your needs by changing:\n\n * the spectral and quadrature (g) grids,\n * the pressure/temperature grid.\n* Create tables for a mix of gases using tables for individual gases.\n* Create your own tables from high-resolution spectra (for example from K-spectrum, Helios-K, etc.).\n* Use your data in an integrated radiative transfer framework to simulate planetary atmospheres.\n* Compute the physical state of planetary atmospheres in radiative-convective equilibrium.\n \nFor a complete online documentation, checkout:\nhttp://perso.astrophy.u-bordeaux.fr/~jleconte/exo_k-doc/index.html\n\nIn this repository, you'll find a [tutorial jupyter notebook](https://forge.oasu.u-bordeaux.fr/jleconte/exo_k-public/-/blob/public/tutorials/tutorial-exo_k.ipynb) that will show you how to do all that\nwith concrete examples that you can run on your own machine. Many important concepts and options are\npresented along the way.\n\nEnjoy!\n\nJ. Leconte\n\n# Acknowledgements\n\nIf you use this library in your research, please acknowledge it by citing\n[Leconte (2021)](https://ui.adsabs.harvard.edu/abs/2021A%26A...645A..20L/abstract):\n\n * Spectral binning of precomputed correlated-k coefficients. **Astronomy and Astrophysics** 645. Leconte, J. 2021. doi:10.1051/0004-6361/202039040\n\nThis project has received funding from the European Research Council (ERC)\nunder the European Union's Horizon 2020 research and innovation programme\n(grant agreement n\u00b0 679030/WHIPLASH).\n\nThe framework for this documentation has been developped by Aurelien Falco using Sphinx.\nThe Framework for automatic testing has been developped by Alexandre Mechineau. \n\n# last release (see past releases below)\n\nv1.2.2 (September 2023): Improvement have been made on the development side. We added a conda environment allowing \nto easily contribute to `Exo_k`. Dependencies have been updated.\n\n# Installation\n\nExo_k can be installed using pip (without cloning the repository;\ndependencies should be downloaded automatically):\n```shell\npip install exo_k\n```\n\n# Usage\n\nTo learn how to use `exo_k`, you can follow the [tutorial jupyter notebook](https://forge.oasu.u-bordeaux.fr/jleconte/exo_k-public/-/blob/public/tutorial-exo_k.ipynb).\n\nHave fun!\n\n# Links\n\n* Project homepage: http://perso.astrophy.u-bordeaux.fr/~jleconte/\n* Code repository: https://forge.oasu.u-bordeaux.fr/jleconte/exo_k-public\n* Documentation: http://perso.astrophy.u-bordeaux.fr/~jleconte/exo_k-doc/index.html\n* Contact: jeremy.leconte at u-bordeaux.fr\n\n\n# past releases\n\nv1.2.1 (June 2023): Fixes some minor bugs in the atmospheric evolution module.\nAddition of a contribution function in the atmospheric radiative transfer module.\nSee the atmosphere tutorial for an example.\n\nv1.2.0 (July 2022): The model for atmospheric evolution is finally stable and documented.\nThe atm module has also seen several note worthy additions: surface albedo, oceans. \nWe also added a framework for an automatic test suite. In particular, we can test several python versions. Additional tests should rapidly come along.\nRosseland and Planck mean opacities can now be computed from radiative tables. \n\nv1.1.0 (August 2021): New scheme for the computation of atmospheric emission/transmission\nto ensure an improved numerical accuracy. The variable names to instantiate atm objects have\nchanged accordingly (see tutorial). \n\nv1.0.2 (June 2021): Adds a few missing dependencies. Enables computation of thermal\nemission spectra with scattering through the two-stream method (full documentation pending). \nEnables creating Xtables for a mix of gases (CIA can be added as well). Solves some issues\nwith the 2018 Hitran CIA format.\n\nv1.0.1 (Jan 2021): Solves a binary/string conversion issue introduced by version 3 of h5py.\nEnables linear interpolation in pressure (default is log). Enables creation of\nempty tables to be filled later and extension of the spectral range of existing tables. \n\nv1.0.0 (Dec 2020): Finally our first official version. Creation of a\n'examples' notebook with fully worked out use cases for the `Exo_k`. \n\nv0.0.5 (Oct 2020): Ensures compatibility with latest Exomol correlated-k and cross-section tables.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Library to handle radiative opacities from various sources for atmospheric applications",
"version": "1.2.2",
"project_urls": {
"Documentation": "http://perso.astrophy.u-bordeaux.fr/~jleconte/exo_k-doc/index.html",
"Homepage": "https://forge.oasu.u-bordeaux.fr/jleconte/exo_k-public",
"Repository": "https://forge.oasu.u-bordeaux.fr/jleconte/exo_k-public"
},
"split_keywords": [
"opacities",
"cross sections",
"correlated-k",
"spectra",
"atmosphere",
"atmospheric",
"exoplanet",
"radiative transfer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f236201b9b252761e6b2a97a4c606e2e0f74f5f61576d7571a15b51e8475c685",
"md5": "f17f7553704229f5ef45b8f1b88eaea1",
"sha256": "1823d297289fb7a5cfaf94a76000dec383af41763d5f1706c12d1f452f534ccb"
},
"downloads": -1,
"filename": "exo_k-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f17f7553704229f5ef45b8f1b88eaea1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 174683,
"upload_time": "2023-10-25T13:43:54",
"upload_time_iso_8601": "2023-10-25T13:43:54.487318Z",
"url": "https://files.pythonhosted.org/packages/f2/36/201b9b252761e6b2a97a4c606e2e0f74f5f61576d7571a15b51e8475c685/exo_k-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "16a1f436f3f1287e4e3821730171896bdc2fe9d912dcbc4aab3e834bb9e16969",
"md5": "ae76d4e2711eeef94126db8485fb7b56",
"sha256": "0fc3927fab3d4087095040a3da204b289cb7297276355681bb414b898276a2d7"
},
"downloads": -1,
"filename": "exo_k-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "ae76d4e2711eeef94126db8485fb7b56",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 151337,
"upload_time": "2023-10-25T13:43:56",
"upload_time_iso_8601": "2023-10-25T13:43:56.480114Z",
"url": "https://files.pythonhosted.org/packages/16/a1/f436f3f1287e4e3821730171896bdc2fe9d912dcbc4aab3e834bb9e16969/exo_k-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 13:43:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "exo-k"
}
JSON