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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file fwl_zephyrus-24.10.15.tar.gz.

File metadata

  • Download URL: fwl_zephyrus-24.10.15.tar.gz
  • Upload date:
  • Size: 19.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for fwl_zephyrus-24.10.15.tar.gz
Algorithm Hash digest
SHA256 8d81547eb1e0c11437dbd21ff782015bc980cf940582d11353b1d59eb4ac4050
MD5 c3bf026b7b7c9dc446df642a93157f40
BLAKE2b-256 27e5d64aef316edf62fd3958de04a372abe9670a8fa92500d89d271ae51db959

See more details on using hashes here.

File details

Details for the file fwl_zephyrus-24.10.15-py3-none-any.whl.

File metadata

File hashes

Hashes for fwl_zephyrus-24.10.15-py3-none-any.whl
Algorithm Hash digest
SHA256 2f4ff5a34758c9d6c4dd343ab19b2ac1ba5a0469ded442c83aff2bf31fbc3b52
MD5 87d77d85faf1beb5745930a516495fc2
BLAKE2b-256 fefd05964c1fd82f70f25c5e20b46f972130983c0207499997c940637b9645d1

See more details on using hashes here.

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