Skip to content

Getting started

Usage within the PROTEUS framework

CALLIOPE is most commonly installed and used as part of the PROTEUS framework. For coupled atmosphere-interior runs, the PROTEUS Getting Started guide is the right entry point; this site documents the standalone CALLIOPE API and the contract it exposes to PROTEUS.

Quick path

  1. Install CALLIOPE Editable install with the docs extra so you can also rebuild this site.
    See Installation guide.

  2. Configure your problem Build the input dictionary that CALLIOPE expects: planet mass, gravity, radius, \(T_\mathrm{magma}\), \(\Phi_\mathrm{global}\), \(\Delta\mathrm{IW}\), plus the included-volatile flags.
    See Configuration.

  3. Run the equilibrium solver Call equilibrium_atmosphere(target, ddict) from the calliope.solve module on your prepared input.
    See Usage, or follow the end-to-end First run tutorial.

What do you want to do?