Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update author list and make references explicit.
  • Loading branch information
timlichtenberg authored Nov 13, 2024
1 parent b5e938e commit 5e5c55b
Showing 1 changed file with 37 additions and 8 deletions.
45 changes: 37 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@

# PROTEUS Framework for Planetary Evolution

**PROTEUS** is a Python framework that simulates the coupled evolution
of the atmospheres and interiors of rocky planets.
**PROTEUS** is a modular Python framework that simulates the coupled evolution of the atmospheres and interiors of rocky planets.

## Installation instructions

Expand All @@ -29,14 +28,10 @@ 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 V. Sastre | m.c.villamil.sastre[at]rug.nl |
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 |
Patrick Sanan | patrick.sanan[at]gmail.com |
Raymond Pierrehumbert | raymond.pierrehumbert[at]physics.ox.ac.uk |
Ryan Boukrouche | ryan.boukrouche[at]astro.su.se |
Shang-Min Tsai | shangmin.tsai[at]ucr.edu |
Hamish Innes | hamish.innes[at]fu-berlin.de |

## Repository structure

Expand All @@ -49,5 +44,39 @@ Hamish Innes | hamish.innes[at]fu-berlin.de |
| `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 |
| `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.

0 comments on commit 5e5c55b

Please sign in to comment.