:orphan:

Examples Gallery
================

Below are some galleries demonstrating features, common use cases,
and tutorials for getting started.


.. raw:: html

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

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Python Script Examples
----------------------
These examples demonstrate expected use cases for the package, and illustrate some of the
core concepts.






.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example  a performs a short,  open, and load (SOL) calibration with a linear sensitivity analysis.">

.. only:: html

  .. image:: /auto_examples/grp0_PyScriptExamples/images/thumb/sphx_glr_plot_e00_SOL_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_grp0_PyScriptExamples_plot_e00_SOL.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">SOL Calibration in Python</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Using RMEMeas and RMEProp in Python
-----------------------------------

Fundementals you should know to get started with Rocky Mountain Ellipse.


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a basic example demonstrating how to create and use RMEMeas objects. In this example we go over different ways to initialize one from scratch, how to create linear uncertainty mechanisms, and how to create probability distributions for Monte Carlo analysis. Indexing and interpolating are also briefly discussed.">

.. only:: html

  .. image:: /auto_examples/grp1_RME_gettingstarted/images/thumb/sphx_glr_plot_e00_creating_RMEMeas_objects_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_grp1_RME_gettingstarted_plot_e00_creating_RMEMeas_objects.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a basic example demonstrating how to propagate RMEMeas objects through functions.">

.. only:: html

  .. image:: /auto_examples/grp1_RME_gettingstarted/images/thumb/sphx_glr_plot_e01_basic_uncertainty_analysis_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_grp1_RME_gettingstarted_plot_e01_basic_uncertainty_analysis.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Basics of RME Propagation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a basic example demonstrating how to read and write a RMEMeas object.">

.. only:: html

  .. image:: /auto_examples/grp1_RME_gettingstarted/images/thumb/sphx_glr_plot_e03_reading_writing_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_grp1_RME_gettingstarted_plot_e03_reading_writing.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Reading/Writing RMEMeas Objects</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A common problem is when multiple inputs into a workflow share a common dimension like frequency, but those frequency grids aren&#x27;t aligned properly. This often results in having to manually trim down arrays based on a known frequency list.">

.. only:: html

  .. image:: /auto_examples/grp1_RME_gettingstarted/images/thumb/sphx_glr_plot_e04_common_grid_handling_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_grp1_RME_gettingstarted_plot_e04_common_grid_handling.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Common Grid Handling</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Here we go over how to use a propagator with the vectorized setting turned off.">

.. only:: html

  .. image:: /auto_examples/grp1_RME_gettingstarted/images/thumb/sphx_glr_plot_e05_vectorizing_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_grp1_RME_gettingstarted_plot_e05_vectorizing.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Using Non-Vectorized Propagation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The RME was built to work best with complex and float data-types inside xarray DataArrays. However, the propagation algorithms are agnostic to what&#x27;s inside the DataArray so the basic functionality of wrapping a function in a propagator will work regardless of what data type you put in them.">

.. only:: html

  .. image:: /auto_examples/grp1_RME_gettingstarted/images/thumb/sphx_glr_plot_e06_using_other_datatypes_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_grp1_RME_gettingstarted_plot_e06_using_other_datatypes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Using Arbitrary Data Types</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Using Array Schema in Python
----------------------------

Some examples for using Array Schema in Python


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Array schema are json documents that act as metadata describing the structure of array-like data. The submodule provides some python bindings for generating the schema in python.">

.. only:: html

  .. image:: /auto_examples/grp2_ArrSchema/images/thumb/sphx_glr_plot_e00_making_schema_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_grp2_ArrSchema_plot_e00_making_schema.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Defining Array Schema</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /auto_examples/grp0_PyScriptExamples/index.rst
   /auto_examples/grp1_RME_gettingstarted/index.rst
   /auto_examples/grp2_ArrSchema/index.rst


.. 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>`_