Skip to content

FormingWorlds/ZEPHYRUS

Repository files navigation

Documentation Status Coverage

ZEPHYRUS

Zephyrus provides models to compute atmospheric escape of exoplanets.

Documentation

https://fwl-zephyrus.readthedocs.io

Contributors

Repository structure

  • README.md - This file
  • docs/ - Documentation sources
  • src/zephyrus/ - Zephyrus sources
  • examples/ - Typical use scripts
  • tests/ - Zephyrus tests
  • tools/ - Useful tools

Installation instructions

  1. Basic install
pip install fwl-zephyrus
  1. Developper install with code sources
git clone [email protected]:FormingWorlds/ZEPHYRUS.git
cd ZEPHYRUS
pip install -e .
  1. Download input data The fwl-mors python package is used to compute the XUV stellar incoming flux on the planet, which most escape models rely on. This package requires a set of stellar evolution data, stored in the OSF repository. To download the data follow the following steps.
    • Set the environment variable FWL_DATA to define where the data files will be stored
      • export FWL_DATA=...
      • This can be done permanently by entering this line into you ~/.profile file.
    • Run the following command to download all evolution track data
      • mors download all

Run instructions

In the examples folder you can find python scripts showing typical usecases/workflows of escape computation with Zephyrus.