API Reference

This section documents the methods and functions available in the Peridoxia package.

Contents

User-Facing Modules

• Main Model
  • ModelRun
  • PhaseHistory
  • OlivineHistory
  • OrthopyroxeneHistory
  • ClinopyroxeneHistory
  • SpinelHistory
  • GarnetHistory
  • LiquidHistory
  • SystemHistory
• Data Structures
  • normalize()
  • get_oxide_moles()
  • get_element_moles()
  • PhaseDictionaries
  • Assemblage
  • Phase
  • Olivine
  • Orthopyroxene
  • Clinopyroxene
  • Spinel
  • Garnet
  • Liquid
  • System
• Input Composition
  • get_WH05_starting_comp()
  • get_starting_comp_from_file()
  • garnet_project()
• Plotting and Saving
  • plot_model_runs()
  • save_data_tables()

Advanced Modules

• Cation Equilibration
  • Equilibrate_Cations()
  • Exchange_Cations()
• Reactions
  • define_reaction()
  • normalize_reaction()
  • get_reactants_and_products_adjusted_for_Mg_num_Cr_num()
  • apply_reaction()
  • gt_olv__spl_opx()
  • gt__opx_opxTs()
  • Ca_gt_olv__spl_cpx()
  • Ca_gt__cpx_cpxTs()
  • redox_rxn_spl_field()
  • adjust_bulk_Fe2O3()
  • redox_exchange()
  • melting_rxn_gt_field()
  • melting_rxn_spl_field()
  • fractionate_liquid_assemblage()
  • Ts_melting_adjustment()
• P-T-F Parameterization
  • PTF_geotherm()
• Partitioning Constraints
  • PartitioningConstraintCalculator