Skip to main content

Atmospheric escape models of exoplanets.

Project description

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 git@github.com: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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fwl_zephyrus-24.10.15.tar.gz (19.1 kB view hashes)

Uploaded Source

Built Distribution

fwl_zephyrus-24.10.15-py3-none-any.whl (18.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page