Metadata-Version: 2.1
Name: pytmosph3r
Version: 2.1.0
Summary: Pytmosph3Rn, generating transmission spectra from 3D atmospheric simulations
Home-page: https://forge.oasu.u-bordeaux.fr/LAB/whiplash/pytmosph3r-2
Author: Aurélien Falco
Author-email: aurelien.falco@u-bordeaux.fr
License: BSD
Keywords: exoplanet,simulation,pytmosph3r,spectra,atmosphere,atmospheric
Platform: UNKNOWN
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 :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Provides: pytmosph3r
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: gitpython
Requires-Dist: cython
Requires-Dist: configobj
Requires-Dist: scipy
Requires-Dist: numba (>=0.49)
Requires-Dist: astropy
Requires-Dist: netCDF4
Requires-Dist: h5py
Requires-Dist: psutil
Requires-Dist: ai.cs
Requires-Dist: pandas
Requires-Dist: tqdm
Requires-Dist: mpi4py
Requires-Dist: exo-k (>=1.1.1)
Provides-Extra: plot
Requires-Dist: matplotlib ; extra == 'plot'

# pytmosph3r

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 source

Install pytmosph3r:
```
pip install -e .
```
Or by running the [setup.py](./setup.py) script:
```
python setup.py install
```
However the first method is to be preferred for developing.

To generate the documentation, you will need to install the following packages:
```
pip install nbsphinx sphinx-autoapi sphinx_rtd_theme sphinxcontrib-bibtex sphinx-argparse
conda install sphinx # installs more (required) dependencies than pip
```
You can then generate the documentation by running:
```
python setup.py doc
```
(or by simply running `make` in the `doc/` folder). 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).

