Magrathea Documentation

Welcome! This site explains how to install, run, and extend Magrathea.
It also hosts an auto-generated C++ API Reference from the source code.

User Guide

• Installation and First Run
  • 🪐 Overview
  • ⚙️ 1. Prerequisites
  • 📦 2. Getting the Code
  • 🧱 3. Building MAGRATHEA
  • 🚀 4. Running a Test Planet
  • 📊 5. Output
  • 🧩 6. Next Steps: Other Run Modes
  • 📚 7. Learn More
• Run Modes and .cfg files
  • Global Configuration Parameters
  • Overview
  • Mode 0 — Full 4-Layer Solver (Default)
  • Mode 1 — Temperature-Free Solver
  • Mode 2 — Two-Layer Mass–Radius Solver
  • Mode 3 — Bulk Planet List Solver
  • Mode 4 — Composition Finder
  • Mode 5 — On-the-Fly EOS Modification
  • Mode 6 — Iterated EOS Variation (Two-Layer)
  • Mode 7 — Iterated EOS Variation (Full Solver)
  • Mode 8 — MCMC Composition Inference
  • Summary Table
• Phase Diagrams
  • What a “phase diagram” is (in code)
  • Built‑in phase diagrams and config names
  • How selection works (mechanics)
  • Adding your own phase diagram
  • Gotchas and best practices
  • Quick reference: where things live
  • Example: custom “dry super‑Earth” mantle
  • Minimal .cfg snippet using built‑ins
• Equation of State (EOS) Library
  • Default EOS Set
  • Iron EOS
  • Silicate and Mantle EOS
  • Water, Ice, and Hydrosphere EOS
  • Atmosphere and Gas EOS
  • Carbon and Carbides
  • Calibration and Miscellaneous Metals
  • EOS Parameter Schema
  • Implementation Notes

Reference

• API Reference: How to Document Your C++
  • Minimal Examples
• C++ API
  • Class Hierarchy
  • File Hierarchy
  • Full API