[](https://fwl-zephyrus.readthedocs.io/en/latest/?badge=latest)
# ZEPHYRUS
Zephyrus provides models to compute atmospheric escape of exoplanets.
### Documentation
https://fwl-zephyrus.readthedocs.io
### Contributors
* Emma Postolec (e.n.postolec[at]rug.nl)
* Tim Lichtenberg (tim.lichtenberg@rug.nl)
* Laurent Soucasse (l.soucasse@esciencecenter.nl)
### 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
```console
pip install fwl-zephyrus
```
2. Developper install with code sources
```console
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](https://osf.io/9u3fb/). 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "fwl-zephyrus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "exoplanet, escape",
"author": null,
"author_email": "Emma Postolec <e.n.postolec@rug.nl>, Tim Lichtenberg <tim.lichtenberg@rug.nl>, Laurent Soucasse <l.soucasse@esciencecenter.nl>",
"download_url": "https://files.pythonhosted.org/packages/27/e5/d64aef316edf62fd3958de04a372abe9670a8fa92500d89d271ae51db959/fwl_zephyrus-24.10.15.tar.gz",
"platform": null,
"description": "[](https://fwl-zephyrus.readthedocs.io/en/latest/?badge=latest)\n\n\n# ZEPHYRUS\n\nZephyrus provides models to compute atmospheric escape of exoplanets.\n\n### Documentation\nhttps://fwl-zephyrus.readthedocs.io\n\n### Contributors\n* Emma Postolec (e.n.postolec[at]rug.nl)\n* Tim Lichtenberg (tim.lichtenberg@rug.nl)\n* Laurent Soucasse (l.soucasse@esciencecenter.nl)\n\n### Repository structure\n* `README.md` - This file\n* `docs/` - Documentation sources\n* `src/zephyrus/` - Zephyrus sources\n* `examples/` - Typical use scripts\n* `tests/` - Zephyrus tests\n* `tools/` - Useful tools\n\n### Installation instructions\n1. Basic install\n```console\npip install fwl-zephyrus\n```\n2. Developper install with code sources\n```console\ngit clone git@github.com:FormingWorlds/ZEPHYRUS.git\ncd ZEPHYRUS\npip install -e .\n```\n3. Download input data\nThe `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](https://osf.io/9u3fb/). To download the data follow the following steps.\n * Set the environment variable FWL_DATA to define where the data files will be stored\n * `export FWL_DATA=...`\n * This can be done permanently by entering this line into you `~/.profile` file.\n * Run the following command to download all evolution track data\n * `mors download all`\n\n### Run instructions\nIn the examples folder you can find python scripts showing typical usecases/workflows of escape computation with Zephyrus.\n",
"bugtrack_url": null,
"license": "Apache 2.0 License",
"summary": "Atmospheric escape models of exoplanets.",
"version": "24.10.15",
"project_urls": {
"homepage": "https://github.com/FormingWorlds/ZEPHYRUS"
},
"split_keywords": [
"exoplanet",
" escape"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fefd05964c1fd82f70f25c5e20b46f972130983c0207499997c940637b9645d1",
"md5": "87d77d85faf1beb5745930a516495fc2",
"sha256": "2f4ff5a34758c9d6c4dd343ab19b2ac1ba5a0469ded442c83aff2bf31fbc3b52"
},
"downloads": -1,
"filename": "fwl_zephyrus-24.10.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87d77d85faf1beb5745930a516495fc2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 18643,
"upload_time": "2024-10-15T11:42:50",
"upload_time_iso_8601": "2024-10-15T11:42:50.028264Z",
"url": "https://files.pythonhosted.org/packages/fe/fd/05964c1fd82f70f25c5e20b46f972130983c0207499997c940637b9645d1/fwl_zephyrus-24.10.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "27e5d64aef316edf62fd3958de04a372abe9670a8fa92500d89d271ae51db959",
"md5": "c3bf026b7b7c9dc446df642a93157f40",
"sha256": "8d81547eb1e0c11437dbd21ff782015bc980cf940582d11353b1d59eb4ac4050"
},
"downloads": -1,
"filename": "fwl_zephyrus-24.10.15.tar.gz",
"has_sig": false,
"md5_digest": "c3bf026b7b7c9dc446df642a93157f40",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19116,
"upload_time": "2024-10-15T11:42:51",
"upload_time_iso_8601": "2024-10-15T11:42:51.608798Z",
"url": "https://files.pythonhosted.org/packages/27/e5/d64aef316edf62fd3958de04a372abe9670a8fa92500d89d271ae51db959/fwl_zephyrus-24.10.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 11:42:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FormingWorlds",
"github_project": "ZEPHYRUS",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "fwl-mors",
"specs": [
[
">=",
"24.10.1"
]
]
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "numpy",
"specs": []
}
],
"lcname": "fwl-zephyrus"
}
JSON
