Metadata-Version: 2.4
Name: pytmosph3r
Version: 2.4.0
Summary: Pytmosph3R, generating transmission spectra from 3D atmospheric simulations
Project-URL: documentation, https://lab.pages.in2p3.fr/whiplash-public/Pytmosph3R
Project-URL: homepage, https://gitlab.in2p3.fr/LAB/whiplash-public/Pytmosph3R
Project-URL: repository, https://gitlab.in2p3.fr/LAB/whiplash-public/Pytmosph3R
Author-email: Aurélien Falco <aurelien.falco@u-bordeaux.fr>, Jeremy Leconte <jeremy.leconte@u-bordeaux.fr>, Alexandre Mechineau <alexandre.mechineau@u-bordeaux.fr>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: atmosphere,atmospheric,exoplanet,pytmosph3r,simulation,spectra
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Requires-Dist: configobj>=5.0.9
Requires-Dist: exo-k>=1.3.1
Requires-Dist: matplotlib>=3.7.3
Requires-Dist: psutil>=6.1.1
Requires-Dist: tqdm>=4.67.1
Requires-Dist: typing-extensions>=4.15
Requires-Dist: wand>=0.6.13
Description-Content-Type: text/markdown

# Pytmosph3r

![Stable Version](https://img.shields.io/pypi/v/pytmosph3r?label=Stable)
![Python Versions](https://img.shields.io/pypi/pyversions/pytmosph3r?label=Python)
[![Poetry](https://img.shields.io/badge/Poetry-blue?logo=poetry)](https://python-poetry.org/)
[![Taskfile](https://img.shields.io/badge/Taskfile-blue?logo=task)](https://taskfile.dev/)

Pytmosph3R is a Python-3 library that computes transmission spectra based on 3D atmospheric simulations, for example performed with the LMDZ generic global climate model.

## Prerequisites

* numpy

## Installing from PyPI

Pytmosph3r is available on the PyPI repository. You can install the latest version available with:
```
pip install pytmosph3r
```
Don't forget to install numpy beforehand.

## Installing from source

If you intend to develop or get the latest (unreleased) developments, you can clone (and move in) the current repository and then install Pytmosph3R using:
```
pip install -e .
```

Don't forget to update `pip` if errors are raised.

To generate the documentation, you will need to install the following packages:
```
pip install nbsphinx nbsphinx_link sphinx_math_dollar sphinx-autoapi sphinx_rtd_theme sphinxcontrib-bibtex sphinx-argparse
conda install sphinx pandoc # installs more (required) dependencies than pip
```
You can then generate the documentation by running in the `doc/` folder:
```
make
```
The documentation will be generated in the doc/html folder (you can open the [index.html](doc/html/index.html) file to check it out using your favorite browser).

Note that you need to set the environment variable `FASTCHEM_DIR` to the location of the folder containing [FastChem](https://github.com/exoclime/FastChem) if you want to use that functionality (WIP).

## Running

To get help:
```
pytmosph3r -h
```

See the [documentation](http://perso.astrophy.u-bordeaux.fr/~jleconte/pytmosph3r-doc/index.html) for more information (read instructions in `Installation` just above to generate the doc).
