ZEPHYRUS for atmospheric escape

Zephyrus is a module used to compute atmospheric escape of exoplanets. In Greek mythology, Zephyrus is the God of the West wind. He is often associated with a small breeze. Zephyrus is also the messenger of spring.

Documentation

https://proteus-framework.org/ZEPHYRUS/

Contributors

• Emma Postolec (e.n.postolec@rug.nl)
• Tim Lichtenberg (tim.lichtenberg@rug.nl)
• Laurent Soucasse (l.soucasse@esciencecenter.nl)
• Harrison Nicholls (harrison.nicholls@physics.ox.ac.uk)

Repository structure

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

Installation instructions

1. Basic install

pip install fwl-zephyrus

2. Developer install with code sources

git clone git@github.com:FormingWorlds/ZEPHYRUS.git
cd ZEPHYRUS
pip install -e .

3. 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 your ~/.bashrc file.
   • Run the following command to download all evolution track data
     • mors download all

Run instructions

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