:orphan:

Examples
========

This section contains a gallery of examples


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="An omf TensorGridBlockModel represents a Block Model, and can be converted to a Pandas DataFram...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_01_omf_blockmodel_to_pandas_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_01_omf_blockmodel_to_pandas.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">OMF Block Model to DataFrame</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to read a block model from an OMF file, modify it using pandas, a...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_02_pandas_to_omf_blockmodel_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_02_pandas_to_omf_blockmodel.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Pandas Block Model to OMF</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A parquet file is a columnar storage format, enabling column by column reading and writing.  Th...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_03_omf_blockmodel_to_parquet_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_03_omf_blockmodel_to_parquet.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">OMF Block Model to Parquet</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Profiling a dataset is a common task in data analysis.  This example demonstrates how to profil...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_04_omf_profile_blockmodel_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_04_omf_profile_blockmodel.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to validate a pandas block model with a pandera schema prior to w...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_05_validate_blockmodel_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_05_validate_blockmodel.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="OMF allows storage of multiple block models in a single file.  This example demonstrates how to...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_06_reading_multiple_blockmodels_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_06_reading_multiple_blockmodels.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Reading Multiple Block Models</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="It is always useful to visually validate our data. In this example, we will read a block model ...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_07_visualise_blockmodel_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_07_visualise_blockmodel.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Visualise a BlockModel</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A block model is a 3D array of cells, each with a set of attributes.  However, it is convenient...">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_08_validate_blockmodel_sort_order_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_08_validate_blockmodel_sort_order.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Validate BlockModel Sort Order</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/01_omf_blockmodel_to_pandas
   /auto_examples/02_pandas_to_omf_blockmodel
   /auto_examples/03_omf_blockmodel_to_parquet
   /auto_examples/04_omf_profile_blockmodel
   /auto_examples/05_validate_blockmodel
   /auto_examples/06_reading_multiple_blockmodels
   /auto_examples/07_visualise_blockmodel
   /auto_examples/08_validate_blockmodel_sort_order


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

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

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