==============================
MagmaPEC quickstart
==============================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   about
   getting_started
   examples
   models
   code_documentation
   /notebooks/benchmark
   support
   license

About
-----
MagmaPEC is a python based tool set for calculating post-entrapment crystallisation extents for olivine-hosted melt inclusions and includes error propagation of various parameters through a Monte-Carlo simulation.

Installation
------------
MagmaPEC can be installed with pip by running:

.. code-block:: bash

    pip install magmapec

in a terminal.
If you want to install from a specific git branch or release, use:

.. code-block:: bash

    pip install git+https://github.com/TDGerve/MagmaPEC.git@tag
    
where *tag* should be repleaced by the release tag or branch name (e.g. *v1.0.0* or *development*)


Indices and tables
------------------


* :ref:`genindex`
* :ref:`search`