frogr: from gas to retrieval#

PyPI Status Python Version License

Read the documentation at https://frogr-from-gas-to-retrieval.readthedocs.io/ Tests Codecov

pre-commit Black

Features#

  • Use the ATMO equilibrium chemistry plugin in your TauREx 3.1 forward models and retrievals.

Requirements#

  • Ensure that you have a working installation of ATMO on your machine (https://www.gitlab.erc-atmo.eu/1-2d_tools/atmo). If you need access to ATMO, please contact Pascal Tremblin: pascal.tremblin@cea.fr

  • You will need a working installation of TauREx 3.1 on your machine, with associated required Python packages: https://taurex3-public.readthedocs.io/

Installation#

You can install frogr by cloning this Github and installing via the terminal. This is done by:

Cloning the directory using:

$ git clone https://github.com/michellebieger/frogr.git

Move into frogr’s folder:

$ cd frogr

Install by then typing in:

$ pip install .

You can check the installation by importing frogr into Python:

$ python -c "import frogr; print(frogr.__version__)"

If there are no errors, you have been successful!

Usage#

Please see the Command-line Reference for details.

License#

Distributed under the terms of the GPL 3.0 license, frogr is free and open source software.

Issues#

If you encounter any problems, please email michellebieger@live.com with a detailed description of the issue.

Credits#

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.