Installation: optional modules¶
Install PROTEUS first
Please follow the quick installation guide or manual installation guide before installing optional modules.
SPIDER and PETSc¶
SPIDER is a C-based interior thermal evolution solver. It requires PETSc (a numerical computing library) and a C compiler. Most configurations use Aragog instead, which is written in Python/JAX and needs no additional compiled dependencies.
Warning
PETSc requires Python <= 3.12. Make sure your conda environment uses Python 3.12.
bash tools/get_petsc.sh
bash tools/get_spider.sh
The PETSc script downloads a pre-compiled version from OSF and configures
PETSC_DIR and PETSC_ARCH automatically.
Fedora / RHEL
If you encounter errors moving libraries, see Troubleshooting: PETSc on Fedora/RHEL.
The script detects Apple Silicon vs Intel and uses Homebrew's MPI. If you encounter issues, see Troubleshooting: PETSc on Apple Silicon.
Multi-phase tidal heating (LovePy)¶
LovePy computes tidal dissipation for multi-phase planetary interiors. It is written in Julia.
bash tools/get_lovepy.sh
Synthetic observations (PetitRADTRANS)¶
PetitRADTRANS generates synthetic transmission and secondary eclipse spectra.
bash tools/get_prt.sh
Note
PetitRADTRANS downloads around 2 GB of opacity data on first use.
Alternative outgassing (atmodeller)¶
atmodeller is an optional
alternative to CALLIOPE, selected with outgas.module = "atmodeller". It is
not installed with PROTEUS by default; a standard run uses CALLIOPE.
pip install "fwl-proteus[atmodeller]"
License
atmodeller is distributed under the GPL-3.0 license; review its terms before installing.
Atmospheric chemistry (VULCAN)¶
VULCAN is an optional atmospheric-photochemistry backend, selected with
atmos_chem.module = "vulcan". It is not required for a standard PROTEUS
run. Install it from PyPI:
pip install "fwl-proteus[vulcan]"
For local development, install as an editable checkout instead:
bash tools/get_vulcan.sh
License
VULCAN is distributed under the GPL-3.0 license; review its terms before installing.