examples.rst

Examples

BurnMan comes with a large collection of example programs under examples/. Below you can find a summary of the different examples. They are grouped into three categories: ref-example-class, ref-example-simple and ref-example-advanced. We suggest starting with ref-example-class, which introduces the main class types in BurnMan. The ref-example-tutorial then provides a useful introduction to the seismic tools for new users of BurnMan.

Finally, we also include the scripts that were used for all computations and figures in the 2014 BurnMan paper in the misc/ folder, see ref-example-paper.

Class examples

The following is a list of examples that introduce the main classes of BurnMan objects:

• ~examples.example_mineral,
• ~examples.example_gibbs_modifiers,
• ~examples.example_solid_solution,
• ~examples.example_composite,
• ~examples.example_anisotropy,
• ~examples.example_anisotropic_mineral,
• ~examples.example_geotherms, and
• ~examples.example_composition.

examples.example_mineral

Resulting figure:

examples.example_gibbs_modifiers

Resulting figures:

examples.example_solid_solution

Resulting figures:

examples.example_composite

Resulting figures:

examples.example_anisotropy

Resulting figure:

examples.example_anisotropic_mineral

Resulting figure:

examples.example_geotherms

Resulting figure:

examples.example_composition

Simple Examples

The following is a list of simple examples:

• ~examples.example_beginner,
• ~examples.example_seismic,
• ~examples.example_composite_seismic_velocities,
• ~examples.example_averaging, and
• ~examples.example_chemical_potentials.

examples.example_beginner

Resulting figure:

examples.example_seismic

Resulting figures:

examples.example_composite_seismic_velocities

Resulting figure:

examples.example_averaging

Resulting figure:

examples.example_chemical_potentials

Resulting figure:

More Advanced Examples

Advanced examples:

• ~examples.example_spintransition,
• ~examples.example_spintransition_thermal,
• ~examples.example_user_input_material,
• ~examples.example_optimize_pv,
• ~examples.example_compare_all_methods,
• ~examples.example_build_planet,
• ~examples.example_fit_eos,,
• ~examples.example_fit_composition, and
• ~examples.example_equilibrate.

examples.example_spintransition

Resulting figure:

examples.example_spintransition_thermal

Resulting figure:

examples.example_user_input_material

examples.example_optimize_pv

Resulting figure:

examples.example_compare_all_methods

Resulting figure:

examples.example_build_planet

Resulting figure:

examples.example_fit_data

Resulting figures:

examples.example_fit_composition

Resulting figure:

examples.example_fit_eos

Last seven resulting figures:

examples.example_equilibrate

Resulting figures:

The classic aluminosilicate diagram.

Ordering in two site orthopyroxene.

Miscibility in the pyrope-grossular garnet system

Mg-Fe partitioning between olivine and ferropericlase.

Phase equilibria in the lower mantle.

A P-T pseudosection for a composition of Fe0.2Mg1.8SiO4 (fo90).

Reproducing Cottaar, Heister, Rose and Unterborn (2014)

In this section we include the scripts that were used for all computations and figures in the 2014 BurnMan paper: Cottaar, Heister, Rose & Unterborn (2014) Cottaar2014

contrib.CHRU2014.paper_averaging

contrib.CHRU2014.paper_benchmark

contrib.CHRU2014.paper_fit_data

contrib.CHRU2014.paper_incorrect_averaging

contrib.CHRU2014.paper_opt_pv

contrib.CHRU2014.paper_onefit

contrib.CHRU2014.paper_uncertain

Misc or work in progress

examples.example_grid

examples.example_woutput