The virtual planet simulator
Switch branches/tags
Clone or download

README.md

vplanet

Build Status Documentation

© 2018 The VPLANET Team.

vplanet is software to simulate planetary system evolution, with a focus on habitability. Physical models, typically consisting of ordinary differential equations, are coupled together to simulate evolution for the age of a system. We strive for full transparency and reproducibility in our software, and this repository contains the source code, extensive documentation, the scripts and files to generate published figures, and scripts to validate the current release. We can't claim we found aliens with closed source software!

To get started, ensure you have clang/gcc installed and follow the QuickStart Guide.

vplanet currently consists of 11 functioning "modules," each containing a set of equations that models a specifc physical process:

AtmEsc: Thermal escape of an atmosphere, including water photolyzation, hydrogen escape, oxygen escape, and oxygen build-up.

Binary: Orbital evolution of a circumbinary planet.

DistOrb: 2nd and 4th order semi-analytic models of orbital evolution outside of resonance.

DistRot: Evolution of a world's rotational axis due to orbital evolution and the stellar torque (includes shape evolution as a function of rotational frequency).

EqTide: Tidal evolution in the equilibrium tide framework.

GalHabit: Evolution of a wide orbit due to the galactic tide and impulses from passing stars (includes radial migration).

POISE: Energy balance climate model including dynamic ice sheets and lithospheric compression/rebound.

RadHeat: Radiogenic heating of a world's interior.

SpiNBody: N-body integrator for the evolution of a system of massive particles.

Stellar: Stellar luminosity, temperature, radius, and mass concentration.

ThermInt: Thermal interior evolution, including magnetic fields, for planets undergoing plate tectonics or stagnant lid evolution.

vplanet is a community project. We're happy to take pull requests; if you want to create one, please issue it to the dev branch. Soon we will include tutorials on adding new input options, governing variables, and modules. It's a platform for planetary science that can grow exponentially, either by adding new physics or by adding competing models for clean comparisons.

The examples/ directory contains input files and scripts for generating the figures in Barnes et al. (2018) and all subsequent module descriptions. The Manual/ directory contains the source code to generate a pdf of Barnes et al. (2018) plus methods sections from subsequent modules. This pdf describes the physics of each module, validates each module against observations or past results, and uses figures from the examples/ directory. {Soon!}

An ecosystem of support software is also publicly available. In this repo, vspace/ contains scripts to generate input files for a parameter space sweep. bigplanet/ contains scripts to store large datasets in HDF5 format and quickly calculate summary properties from an integration, like change in surface temperature. In a separate repository is vplot, which consists of both a command line tool to quickly plot the evolution of a system, but also matplotlib functions to more easily generate publication-worthy figures. Finally, we recommend using approxposterior to quickly obtain posterior distributions of model parameters.

Behind the scenes, the vplanet team maintains code integrity through continuous integration, in which numerous scientific and numerical tests are validated at every commit. See the tests/ directory for the validation checks that the current build passes. Additionally, we use valgrind and addresssanitizer to periodically search for memory issues like leaks, accessing memory beyond array bounds, etc. We are committed to maintaining a stable tool that planetary scientists can rely on for fast analyses of the Solar System and beyond.

If you'd like to stay up to date on vplanet by joining the e-mail list, please send a request to Rory Barnes, rory@astro.washington.edu.

vplanet development has been supported by NASA grants NNA13AA93A, NNX15AN35G, and 13-13NAI7_0024. We also acnkowledge support from the University of Washington and the Carnegie Institute for Science.

Enjoy!