PyRetLIFE 🏴‍☠ ️🪐

Python-based retrievals for LIFE (© by Eleonora)

---

⚡ Quickstart

📦 Installation

The code in this repository is organized as a Python package named pyretlife. Clone this repository and install pyretlife using pip as follows:

git clone https://github.com/LIFE-SpaceMission/LIFE-Retrieval-Framework ;
cd LIFE-Retrieval-Framework ;
pip install -e .

The -e option installs the package in "editable" mode, which means that any changes you make to the code will be immediately available to you without having to reinstall the package.

If you need developer tools (e.g., for running tests, linting, or type-checking), you can install the package with the optional [develop] option:

pip install -e ".[develop]"

The full installation guide with all necessary packages can be found here: https://drive.google.com/file/d/1okJilHcWick3Po6ZepaG0v-EXjdgTect/view?usp=sharing

🐭 Running unit tests

To run the unit tests, use the following command (requires pytest):

pytest tests

If you also want to get a coverage report, use this (requires coverage and pytest-cov):

pytest --cov-report term-missing --cov=pyretlife