[](https://github.com/FormingWorlds/PROTEUS/actions/workflows/tests.yaml)
[](https://fwl-proteus.readthedocs.io/en/latest/?badge=latest)
[](https://opensource.org/licenses/Apache-2.0)
# PROTEUS Framework for Planetary Evolution
**PROTEUS** is a modular Python framework that simulates the coupled evolution of the atmospheres and interiors of rocky planets.
## Installation instructions
See the [installation guide](https://fwl-proteus.readthedocs.io/en/latest/installation/) for steps and troubleshooting advice.
## Run instructions
Only attempt to run PROTEUS after you have followed all of the installation instructions.
See the [usage guide](https://fwl-proteus.readthedocs.io/en/latest/usage/) for more information.
## Contributors
| Name | Email address |
| - | - |
Tim Lichtenberg | tim.lichtenberg[at]rug.nl |
Harrison Nicholls | harrison.nicholls[at]physics.ox.ac.uk |
Laurent Soucasse | l.soucasse[at]esciencecenter.nl |
Stef Smeets | s.smeets[at]esciencecenter.nl |
Dan J. Bower | dbower[at]ethz.ch |
Mariana Sastre | m.c.villamil.sastre[at]rug.nl |
Emma Postolec | e.n.postolec[at]rug.nl |
Mark Hammond | mark.hammond[at]physics.ox.ac.uk |
Raymond Pierrehumbert | raymond.pierrehumbert[at]physics.ox.ac.uk |
## Repository structure
| Object | Description |
| - | - |
| `README.md` | Overview file |
| `pyproject.toml` | Project configuration file |
| `CODE_OF_CONDUCT.md` | Project code of conduct |
| `LICENSE.txt` | Project license |
| `src/proteus` | Source code for PROTEUS |
| `output/` | Output folder with subfolders for each model run |
| `input/` | Input folder (e.g. stellar spectra, example configs) |
| `docs/` | Documentation source files |
| `examples/` | Example cases that the model should be able to reproduce |
## Citation
If you make use of PROTEUS, please reference the following manuscripts, and state the code version used.
```
@ARTICLE{Lichtenberg2021JGRP,
author = {{Lichtenberg}, Tim and {Bower}, Dan J. and {Hammond}, Mark and {Boukrouche}, Ryan and {Sanan}, Patrick and {Tsai}, Shang-Min and {Pierrehumbert}, Raymond T.},
title = "{Vertically Resolved Magma Ocean-Protoatmosphere Evolution: H$_{2}$, H$_{2}$O, CO$_{2}$, CH$_{4}$, CO, O$_{2}$, and N$_{2}$ as Primary Absorbers}",
journal = {Journal of Geophysical Research (Planets)},
year = 2021,
month = feb,
volume = {126},
number = {2},
eid = {e06711},
pages = {e06711},
doi = {10.1029/2020JE006711},
archivePrefix = {arXiv},
eprint = {2101.10991},
primaryClass = {astro-ph.EP},
adsurl = {https://ui.adsabs.harvard.edu/abs/2021JGRE..12606711L}
}
@ARTICLE{Nicholls2025JGRP,
author = {{Nicholls}, Harrison and {Lichtenberg}, Tim and {Bower}, Dan J. and and {Pierrehumbert}, Raymond T.},
title = "{Magma ocean evolution at arbitrary redox state}",
journal = {Journal of Geophysical Research (Planets)},
year = 2025,
pages = {submitted},
adsurl = {https://ui.adsabs.harvard.edu/abs/2021JGRE..12606711L}
}
```
Please see the relevant sub-modules (e.g., [JANUS]([url](https://github.com/FormingWorlds/JANUS)), [MORS]([url](https://github.com/FormingWorlds/MORS)), [SOCRATES]([url](https://github.com/nichollsh/SOCRATES)), [AGNI]([url](https://github.com/nichollsh/AGNI)), [SPIDER]([url](https://github.com/djbower/spider)), [CALLIOPE]([url](https://github.com/FormingWorlds/CALLIOPE)), [ZEPHYRUS]([url](https://github.com/FormingWorlds/ZEPHYRUS))) for further references.
Raw data
{
"_id": null,
"home_page": null,
"name": "fwl-proteus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Astronomy, Exoplanets, Model-coupling",
"author": "Harrison Nicholls, email = harrison.nicholls@physics.ox.ac.uk",
"author_email": "Tim Lichtenberg <tim.lichtenberg@rug.nl>, Laurent Soucasse <l.soucasse@esciencecenter.nl>, Stef Smeets <s.smeets@esciencecenter.nl>, \"Dan J. Bower\" <dbower@ethz.ch>, \"Mariana V. Sastre\" <m.c.villamil.sastre@rug.nl>, Emma Postolec <e.n.postolec@rug.nl>, Mark Hammond <mark.hammond@physics.ox.ac.uk>, Patrick Sanan <patrick.sanan@gmail.com>, Raymond Pierrehumbert <raymond.pierrehumbert@physics.ox.ac.uk>, Ryan Boukrouche <ryan.boukrouche@astro.su.se>, Shang-Min Tsai <shangmin.tsai@ucr.edu>, Hamish Innes <hamish.innes@fu-berlin.de>",
"download_url": "https://files.pythonhosted.org/packages/ed/e7/61c16ddff553ab9d05685f4b4387adef4c2ea13af2021a2f11b4c48d9769/fwl_proteus-24.12.11.tar.gz",
"platform": null,
"description": "[](https://github.com/FormingWorlds/PROTEUS/actions/workflows/tests.yaml)\n\n[](https://fwl-proteus.readthedocs.io/en/latest/?badge=latest)\n[](https://opensource.org/licenses/Apache-2.0)\n\n\n\n\n# PROTEUS Framework for Planetary Evolution\n\n**PROTEUS** is a modular Python framework that simulates the coupled evolution of the atmospheres and interiors of rocky planets.\n\n## Installation instructions\n\nSee the [installation guide](https://fwl-proteus.readthedocs.io/en/latest/installation/) for steps and troubleshooting advice.\n\n## Run instructions\n\nOnly attempt to run PROTEUS after you have followed all of the installation instructions.\nSee the [usage guide](https://fwl-proteus.readthedocs.io/en/latest/usage/) for more information.\n\n## Contributors\n\n| Name | Email address |\n| - | - |\nTim Lichtenberg | tim.lichtenberg[at]rug.nl |\nHarrison Nicholls | harrison.nicholls[at]physics.ox.ac.uk |\nLaurent Soucasse | l.soucasse[at]esciencecenter.nl |\nStef Smeets | s.smeets[at]esciencecenter.nl |\nDan J. Bower | dbower[at]ethz.ch |\nMariana Sastre | m.c.villamil.sastre[at]rug.nl |\nEmma Postolec | e.n.postolec[at]rug.nl |\nMark Hammond | mark.hammond[at]physics.ox.ac.uk |\nRaymond Pierrehumbert | raymond.pierrehumbert[at]physics.ox.ac.uk |\n\n## Repository structure\n\n| Object | Description |\n| - | - |\n| `README.md` | Overview file |\n| `pyproject.toml`\t | Project configuration file |\n| `CODE_OF_CONDUCT.md`\t| Project code of conduct |\n| `LICENSE.txt` | Project license |\n| `src/proteus` | Source code for PROTEUS |\n| `output/` | Output folder with subfolders for each model run |\n| `input/` | Input folder (e.g. stellar spectra, example configs) |\n| `docs/`\t\t\t | Documentation source files |\n| `examples/` | Example cases that the model should be able to reproduce |\n\n## Citation\n\nIf you make use of PROTEUS, please reference the following manuscripts, and state the code version used.\n\n```\n@ARTICLE{Lichtenberg2021JGRP,\n author = {{Lichtenberg}, Tim and {Bower}, Dan J. and {Hammond}, Mark and {Boukrouche}, Ryan and {Sanan}, Patrick and {Tsai}, Shang-Min and {Pierrehumbert}, Raymond T.},\n title = \"{Vertically Resolved Magma Ocean-Protoatmosphere Evolution: H$_{2}$, H$_{2}$O, CO$_{2}$, CH$_{4}$, CO, O$_{2}$, and N$_{2}$ as Primary Absorbers}\",\n journal = {Journal of Geophysical Research (Planets)},\n year = 2021,\n month = feb,\n volume = {126},\n number = {2},\n eid = {e06711},\n pages = {e06711},\n doi = {10.1029/2020JE006711},\narchivePrefix = {arXiv},\n eprint = {2101.10991},\n primaryClass = {astro-ph.EP},\n adsurl = {https://ui.adsabs.harvard.edu/abs/2021JGRE..12606711L}\n}\n\n@ARTICLE{Nicholls2025JGRP,\n author = {{Nicholls}, Harrison and {Lichtenberg}, Tim and {Bower}, Dan J. and and {Pierrehumbert}, Raymond T.},\n title = \"{Magma ocean evolution at arbitrary redox state}\",\n journal = {Journal of Geophysical Research (Planets)},\n year = 2025,\n pages = {submitted},\n adsurl = {https://ui.adsabs.harvard.edu/abs/2021JGRE..12606711L}\n}\n```\n\nPlease see the relevant sub-modules (e.g., [JANUS]([url](https://github.com/FormingWorlds/JANUS)), [MORS]([url](https://github.com/FormingWorlds/MORS)), [SOCRATES]([url](https://github.com/nichollsh/SOCRATES)), [AGNI]([url](https://github.com/nichollsh/AGNI)), [SPIDER]([url](https://github.com/djbower/spider)), [CALLIOPE]([url](https://github.com/FormingWorlds/CALLIOPE)), [ZEPHYRUS]([url](https://github.com/FormingWorlds/ZEPHYRUS))) for further references.\n",
"bugtrack_url": null,
"license": "Apache 2.0 License",
"summary": "Coupled atmosphere-interior framework to simulate the temporal evolution of rocky planets",
"version": "24.12.11",
"project_urls": {
"changelog": "https://github.com/FormingWorlds/PROTEUS/releases",
"documentation": "https://fwl-proteus.readthedocs.io",
"homepage": "https://github.com/FormingWorlds/PROTEUS",
"issues": "https://github.com/FormingWorlds/PROTEUS/issues"
},
"split_keywords": [
"astronomy",
" exoplanets",
" model-coupling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a32df2b1c6878b63b24152127103f2c449f3b8000e82db021133ac14a30cf7b",
"md5": "3eec52f6c8fb4263535c555926fddafd",
"sha256": "54fc5932a487821e31fc32c46344d02f3bf531ce09d951c7c28a31b703283d90"
},
"downloads": -1,
"filename": "fwl_proteus-24.12.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3eec52f6c8fb4263535c555926fddafd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 134485,
"upload_time": "2024-12-12T11:39:55",
"upload_time_iso_8601": "2024-12-12T11:39:55.205401Z",
"url": "https://files.pythonhosted.org/packages/5a/32/df2b1c6878b63b24152127103f2c449f3b8000e82db021133ac14a30cf7b/fwl_proteus-24.12.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ede761c16ddff553ab9d05685f4b4387adef4c2ea13af2021a2f11b4c48d9769",
"md5": "077e2e4545d3c391cbf6cb76c24e930f",
"sha256": "627feb3106062b7e044ac8b5b9a8a324fe738cd4b388a4071ba09e8e1b5a3fa4"
},
"downloads": -1,
"filename": "fwl_proteus-24.12.11.tar.gz",
"has_sig": false,
"md5_digest": "077e2e4545d3c391cbf6cb76c24e930f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 99623,
"upload_time": "2024-12-12T11:39:57",
"upload_time_iso_8601": "2024-12-12T11:39:57.008547Z",
"url": "https://files.pythonhosted.org/packages/ed/e7/61c16ddff553ab9d05685f4b4387adef4c2ea13af2021a2f11b4c48d9769/fwl_proteus-24.12.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 11:39:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FormingWorlds",
"github_project": "PROTEUS",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "attrs",
"specs": []
},
{
"name": "cattrs",
"specs": []
},
{
"name": "fwl-janus",
"specs": [
[
">=",
"24.11.05"
]
]
},
{
"name": "fwl-mors",
"specs": [
[
">=",
"24.11.18"
]
]
},
{
"name": "fwl-calliope",
"specs": [
[
">=",
"24.9.10"
]
]
},
{
"name": "fwl-zephyrus",
"specs": [
[
">=",
"24.10.15"
]
]
},
{
"name": "aragog",
"specs": [
[
">=",
"0.1.8a0"
]
]
},
{
"name": "cmcrameri",
"specs": []
},
{
"name": "juliacall",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "netCDF4",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "scipy",
"specs": []
}
],
"lcname": "fwl-proteus"
}
JSON
