Skip to main content

Planetary accretion and volatile delivery model

Project description

CALLIOPE

License Docs codecov Unit Tests Integration Tests

CALLIOPE is the equilibrium outgassing solver of the PROTEUS coupled atmosphere-interior evolution framework. It computes the partitioning of volatile elements (H, C, N, S) between a partially molten silicate mantle and an overlying gas-phase atmosphere, assuming both reservoirs are in thermochemical equilibrium at the planetary surface.

Given an elemental inventory, a magma ocean temperature, a melt fraction, and an oxygen fugacity (specified as a log10 shift from the iron-wüstite buffer), CALLIOPE returns the surface partial pressures of eleven volatile species, the dissolved volatile masses, and the atmospheric mass.

Named after the Greek muse of eloquence and epic poetry. Pronounced kal-IGH-uh-pee.

Supported species

H2O, CO2, N2, S2 (primary unknowns); H2, CH4, CO, NH3, SO2, H2S, O2 (derived from gas-phase equilibrium).

Documentation

Full documentation is at proteus-framework.org/CALLIOPE, including:

  • Getting started — installation and a quick path to running.
  • First-run tutorial — Earth-like solve with a Δ-IW redox sweep.
  • How-to guides — install, configure, run, couple to PROTEUS, test, release.
  • Explanations — model overview, equilibrium chemistry, solubility laws, oxygen fugacity, mass balance, code architecture.
  • API reference — every public function with NumPy-style docstrings.

Installation

pip install fwl-calliope

Or, for development:

git clone https://github.com/FormingWorlds/CALLIOPE.git
cd CALLIOPE
pip install -e .[develop,docs]

The docs extra pulls in Zensical so you can build this documentation locally with zensical serve.

Quick start

from calliope.solve import equilibrium_atmosphere, get_target_from_params
from calliope.constants import volatile_species

ddict = {
    'M_mantle': 4.03e24,                      # kg
    'gravity': 9.81, 'radius': 6.371e6,
    'T_magma': 2500.0, 'Phi_global': 1.0,
    'fO2_shift_IW': 0.5,                      # log10 shift relative to IW
    'hydrogen_earth_oceans': 1.0, 'CH_ratio': 0.1,
    'nitrogen_ppmw': 2.0, 'sulfur_ppmw': 200.0,
}
for sp in volatile_species:
    ddict[f'{sp}_included'] = 1
    ddict[f'{sp}_initial_bar'] = 0.0

target = get_target_from_params(ddict)
result = equilibrium_atmosphere(target, ddict)
print(f"P_surf = {result['P_surf']:.1f} bar, "
      f"H2O = {result['H2O_bar']:.1f} bar")

See the first-run tutorial for the full walkthrough.

Citation

If you use CALLIOPE in published work, please cite the three methods papers below. The full reference list (chemistry constants, solubility laws, oxygen-fugacity buffers, applications) is on the Publications page.

  • Bower, D.J., Kitzmann, D., Wolf, A.S., Sanan, P., Dorn, C., & Oza, A.V. (2019). Linking the evolution of terrestrial interiors and an early outgassed atmosphere to astrophysical observations. A&A 631, A103. [ADS] [DOI]
  • Bower, D.J., Hakim, K., Sossi, P.A., & Sanan, P. (2022). Retention of water in terrestrial magma oceans and carbon-rich early atmospheres. PSJ 3, 93. [ADS] [DOI]
  • Nicholls, H., Lichtenberg, T., Bower, D.J., & Pierrehumbert, R. (2024). Magma ocean evolution at arbitrary redox state. JGR Planets 129, e2024JE008576. [ADS] [DOI] [arXiv]

License

Apache License 2.0. CALLIOPE is part of the Forming Worlds Lab PROTEUS framework.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fwl_calliope-26.5.13.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fwl_calliope-26.5.13-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

Details for the file fwl_calliope-26.5.13.tar.gz.

File metadata

  • Download URL: fwl_calliope-26.5.13.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fwl_calliope-26.5.13.tar.gz
Algorithm Hash digest
SHA256 f597827ada07625b638a4e6273eb76a6386552bd3f1fdd96f78b913b91c6db1a
MD5 73516566229e220dcb88d8d535d342a9
BLAKE2b-256 843221257d5829a1f26869330b500998048de648d9d4aa69734bc79467f7dd4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for fwl_calliope-26.5.13.tar.gz:

Publisher: publish.yaml on FormingWorlds/CALLIOPE

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fwl_calliope-26.5.13-py3-none-any.whl.

File metadata

  • Download URL: fwl_calliope-26.5.13-py3-none-any.whl
  • Upload date:
  • Size: 20.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fwl_calliope-26.5.13-py3-none-any.whl
Algorithm Hash digest
SHA256 a776c23dfcb1bfa13226d247c43d876c45f0ecb6d13065b50c1233c0875bc364
MD5 cfea04433a7442afb2fdbe8a5a7906b3
BLAKE2b-256 0221fbe810306030877c1d801551c9616310a79a453d4948c61bed3c802f2209

See more details on using hashes here.

Provenance

The following attestation bundles were made for fwl_calliope-26.5.13-py3-none-any.whl:

Publisher: publish.yaml on FormingWorlds/CALLIOPE

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page