:orphan:

Example Gallery
###############




.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Getting Started
===============

Below is a gallery of basic examples.  The simplest object is a `Sample` object,
which is a container for a mass-composition data.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The base object is a Sample, so let&#x27;s create one">

.. only:: html

  .. image:: /auto_examples/examples/01_getting_started/images/thumb/sphx_glr_01_create_sample_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_01_getting_started_01_create_sample.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create Sample</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demonstrate splitting and math operations that preserve the mass balance of components.">

.. only:: html

  .. image:: /auto_examples/examples/01_getting_started/images/thumb/sphx_glr_02_math_operations_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_01_getting_started_02_math_operations.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Math Operations</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demonstrating the plot methods.">

.. only:: html

  .. image:: /auto_examples/examples/01_getting_started/images/thumb/sphx_glr_03_plot_demo_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_01_getting_started_03_plot_demo.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot Demo</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Filtering is often required to reduce the data of a MassComposition object to a specific subset...">

.. only:: html

  .. image:: /auto_examples/examples/01_getting_started/images/thumb/sphx_glr_04_filtering_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_01_getting_started_04_filtering.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Filtering</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/examples/01_getting_started/01_create_sample
   /auto_examples/examples/01_getting_started/02_math_operations
   /auto_examples/examples/01_getting_started/03_plot_demo
   /auto_examples/examples/01_getting_started/04_filtering

Interval Samples
================

Data with an index representing intervals can be used to create an IntervalSample object.
Examples include drill-hole intervals and sieved samples.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example adds a second dimension.  The second dimension is an interval, of the form interva...">

.. only:: html

  .. image:: /auto_examples/examples/02_interval_sample/images/thumb/sphx_glr_01_interval_sample_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_02_interval_sample_01_interval_sample.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Interval Data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Intervals are encountered in Metallurgy, aka fractions, e.g. size fractions.  In that case the ...">

.. only:: html

  .. image:: /auto_examples/examples/02_interval_sample/images/thumb/sphx_glr_02_interval_data_sink_float_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_02_interval_sample_02_interval_data_sink_float.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Interval Data - Sink Float</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This method sorts by the provided direction prior to incrementally removing and discarding the ...">

.. only:: html

  .. image:: /auto_examples/examples/02_interval_sample/images/thumb/sphx_glr_03_incremental_separation_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_02_interval_sample_03_incremental_separation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Incremental Separation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Partition models, (a.k.a. partition curves in the 1 dimensional case) define the separation of ...">

.. only:: html

  .. image:: /auto_examples/examples/02_interval_sample/images/thumb/sphx_glr_04_partition_models_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_02_interval_sample_04_partition_models.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Partition Models</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Interval (or fractional) data is common in metallurgy and mineral processing.  Samples are size...">

.. only:: html

  .. image:: /auto_examples/examples/02_interval_sample/images/thumb/sphx_glr_05_resampling_interval_data_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_02_interval_sample_05_resampling_interval_data.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Resampling Interval Data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The Sink Float metallurgical test splits/fractionates samples by density.  The density fraction...">

.. only:: html

  .. image:: /auto_examples/examples/02_interval_sample/images/thumb/sphx_glr_06_resampling_interval_data_2d_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_02_interval_sample_06_resampling_interval_data_2d.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Resampling 2D Interval Data</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/examples/02_interval_sample/01_interval_sample
   /auto_examples/examples/02_interval_sample/02_interval_data_sink_float
   /auto_examples/examples/02_interval_sample/03_incremental_separation
   /auto_examples/examples/02_interval_sample/04_partition_models
   /auto_examples/examples/02_interval_sample/05_resampling_interval_data
   /auto_examples/examples/02_interval_sample/06_resampling_interval_data_2d

Flowsheets
==========

In the real world, a process flowsheet consists of process streams connected to unit operations.
A `Flowsheet` object represents the same, with a `Stream` object representing the mass-composition flow
and an `Operation` represents the unit-operations (or feed, stockpiles, outputs).





.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Related Sample objects can be managed as a network.  In the Process Engineering/Metallurgy disc...">

.. only:: html

  .. image:: /auto_examples/examples/03_flowsheet/images/thumb/sphx_glr_01_flowsheet_basics_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_03_flowsheet_01_flowsheet_basics.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Flowsheet Basics</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="It is possible to create a Flowsheet object from a file.  This example demonstrates how to crea...">

.. only:: html

  .. image:: /auto_examples/examples/03_flowsheet/images/thumb/sphx_glr_02_flowsheet_from_file_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_03_flowsheet_02_flowsheet_from_file.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Flowsheet from File</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Flowsheets contain a network of streams and operations.  The streams contain data in the form o...">

.. only:: html

  .. image:: /auto_examples/examples/03_flowsheet/images/thumb/sphx_glr_03_filtering_flowsheet_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_03_flowsheet_03_filtering_flowsheet.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Filtering Flowsheets</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/examples/03_flowsheet/01_flowsheet_basics
   /auto_examples/examples/03_flowsheet/02_flowsheet_from_file
   /auto_examples/examples/03_flowsheet/03_filtering_flowsheet

Block Models
============

Below is a gallery of examples based on the BlockModel class.


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to consume an Open Mining Format file">

.. only:: html

  .. image:: /auto_examples/examples/04_block_model/images/thumb/sphx_glr_01_consuming_omf_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_04_block_model_01_consuming_omf.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Consuming OMF</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demonstrates loading a block model in parquet format into pyvista.">

.. only:: html

  .. image:: /auto_examples/examples/04_block_model/images/thumb/sphx_glr_02_load_block_model_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_04_block_model_02_load_block_model.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Load Block Model</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/examples/04_block_model/01_consuming_omf
   /auto_examples/examples/04_block_model/02_load_block_model

Mass Balancing
==============

Below is a gallery of examples to deliver mass balancing.


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A mass balance ensures that sampled/measured data across a system/flowsheet balances.">

.. only:: html

  .. image:: /auto_examples/examples/05_mass_balance/images/thumb/sphx_glr_01_mass_balance_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_05_mass_balance_01_mass_balance.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Mass Balance</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/examples/05_mass_balance/01_mass_balance

Spatial
=======

Below is a gallery of examples that demonstrate mapping and DEM visualisation.


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Mapping provides spatial context.  It is useful in drill hole planning.">

.. only:: html

  .. image:: /auto_examples/examples/06_spatial/images/thumb/sphx_glr_01_mapping_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_examples_06_spatial_01_mapping.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Mapping</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/examples/06_spatial/01_mapping



.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_