.. Peridoxia documentation master file, created by
   sphinx-quickstart on Tue Mar  3 13:47:09 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Peridoxia documentation
===================================

This site provides documentation for the Peridoxia model. The model simulates changes in redox during mantle melting, using empirical partitioning constraints.
It is designed particularly to assess redox changes across the garnet→spinel phase transition.
The model was first published in Birner et al. (2024): https://www.nature.com/articles/s41586-024-07603-w.

* The Installation Guide provides information on how to install the model in a virtual environment.
* The API provides information regarding the methods and functions available in the model. 
* The Gallery provides examples of how to use the model. These examples can be downloaded to the user's machine or accessed in the web browser via interactive MyBinder notebooks.

This model (and the documentation) is a work in progress. For questions, please contact Suzanne Birner at [birners AT berea DOT edu].

Contents
--------

.. toctree::
   :maxdepth: 2
   :titlesonly:

   installation
   files
   api/index
   auto_examples/index