PROTEUS Framework for Planetary Evolution

Documentation

https://proteus-code.readthedocs.io

Contact

https://proteus-code.readthedocs.io/en/latest/contact.html

Contributors

• TL – Tim Lichtenberg (tim.lichtenberg@rug.nl)
• MH – Mark Hammond (mark.hammond@physics.ox.ac.uk)
• DJB – Dan J. Bower (daniel.bower@csh.unibe.ch)
• PS – Patrick Sanan (patrick.sanan@gmail.com)
• RTP – Raymond Pierrehumbert (raymond.pierrehumbert@physics.ox.ac.uk)
• RB – Ryan Boukrouche (ryan.boukrouche@astro.su.se)
• SMT – Shang-Min Tsai (shangmin.tsai@ucr.edu)
• HN – Harrison Nicholls (harrison.nicholls@physics.ox.ac.uk)
• HII - Hamish Innes (hamish.innes@physics.ox.ac.uk)

Repository structure

Object	Description
proteus.py	Main PROTEUS Python script
README.md	Overview file
pyproject.toml	Documentation file
CODE_OF_CONDUCT.md	Project code of conduct
LICENSE	Project license
AEOLUS/	Submodule AEOLUS
SPIDER/	Submodule SPIDER
VULCAN/	Submodule VULCAN
Mors/	Submodule Mors
utils/	Code used for running PROTEUS and its submodules
plot/	Code used for plotting results
output/	Output folder with subfolders for each model run
input/	Input folder (e.g. stellar spectra, example configs)
docs/	Documentation source files
tests/	Test cases that the model should be able to reproduce

Installation instructions

See https://proteus-code.readthedocs.io/en/latest/installation.html for steps and troubleshooting advice.

Run instructions

Only attempt to run PROTEUS after you have followed all of the installation instructions.
If using a fresh shell, it is necessary to perform the following steps:

1. conda activate proteus (if using Anaconda/Miniconda)
2. source PROTEUS.env
   Then you can start the model by running: python proteus.py.
   See the ReadTheDocs pages for more information.

Updating the code

Run git submodule update --recursive --remote