aragog 0.1.0a0

A 1-D parameterised interior dynamics code for rocky or icy planets and moons with liquid and/or solid interiors

Aragog

Under development

This code remains under active development, hence the interface is not stable and should not be relied upon.

About

This is a pure Python version of the SPIDER code originally written in C. Note that the atmosphere module in the original SPIDER code is now supported by a separate and more comprehensive Python package Atmodeller (release forthcoming).

Documentation: https://aragog.readthedocs.io

Citation

If you use Aragog or Spider please cite

• Bower, D.J., P. Sanan, and A.S. Wolf (2018), Numerical solution of a non-linear conservation law applicable to the interior dynamics of partially molten planets, Phys. Earth Planet. Inter., 274, 49-62, doi: 10.1016/j.pepi.2017.11.004, arXiv: https://arxiv.org/abs/1711.07303, EarthArXiv: https://eartharxiv.org/k6tgf

Installation

Aragog is a Python package that can be installed on a variety of platforms (e.g. Mac, Windows, Linux).

Quick install

If you want a GUI way of installing Aragog, particularly if you are a Windows or Spyder user, see here. Otherwise, the instructions below should work to install Aragog using the terminal on a Mac or Linux system.

1. Obtain the source code

Navigate to a location on your computer and obtain the source code:

git clone [e-mail]:ExPlanetology/aragog.git aragog
cd aragog

2. Create a Python environment

The basic procedure is to install Aragog into an environment. For example, if you are using a Conda distribution to create Python environments (e.g. Anaconda), create a new environment to install Aragog. Aragog requires Python >= 3.10:

conda create -n aragog python
conda activate aragog

3. Install into the environment

Install Aragog into the environment using either (a) Poetry or (b) pip. If you are a developer you will probably prefer to use Poetry and if you are an end-user you will probably prefer to use pip. This Gist provides further information.

3a. Option 1: Poetry

This requires that you have you have Poetry installed:

poetry install

3b. Option 2: pip

Alternatively, use pip, where you can include the -e option if you want an editable install .

pip install .

If desired, you will need to manually install the dependencies for testing and documentation (these are automatically installed by Poetry but not when using pip). See the additional dependencies to install in pyproject.toml.

Developer install

See this developer setup guide to set up your system to develop Aragog using VS Code and Poetry.

Documentation

You can compile (and contribute if you wish) to the documentation in the docs/ directory. To compile the documentation you will need to use Poetry and the option --with docs when you run poetry install. See here for further information.

Tests

You can confirm that all tests pass by running pytest in the root directory of Aragog. Please add more tests if you add new features. Note that pip install . in the Quick install instructions will not install pytest so you will need to install pytest into the environment separately.

Other relevant references

• Wolf, A.S. and D.J. Bower (2018), An equation of state for high pressure-temperature liquids (RTpress) with application to MgSiO3 melt, Phys. Earth Planet. Inter., 278, 59-74, doi: 10.1016/j.pepi.2018.02.004, EarthArXiv: https://eartharxiv.org/4c2s5

• Bower, D.J., Kitzmann, D., Wolf, A.S., Sanan, P., Dorn, C., and Oza, A.V. (2019), Linking the evolution of terrestrial interiors and an early outgassed atmosphere to astrophysical observations, Astron. Astrophys., 631, A103, doi: 10.1051/0004-6361/201935710, arXiv: https://arxiv.org/abs/1904.08300

• Bower, D.J., Hakim, K., Sossi, P.A., and Sanan, P. (2022), Retention of water in terrestrial magma oceans and carbon-rich early atmospheres, Planet. Sci. J., 3, 93, doi: 10.3847/PSJ/ac5fb1, arXiv: https://arxiv.org/abs/2110.08029