:orphan:

Interaction Examples & Gallery
==============================

The following examples are meant to show you how to interact with MSNoise using
its API, thus avoiding having to dive into the folder structure.

Users should try examples while checking the :doc:`../api`. (application
programming interface) for understanding the calls to different functions.

In a nutshell, all examples start with the following Python code:

.. code:: python

    from msnoise.api import db
    db = connect()

This, if run in an MSNoise project folder (= a folder where you have already
run ``msnoise db init`` (as explained in :ref:`workflow`)), will provide a
``Session`` object, connected to the database. 


.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Plot a Reference CCF">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_plot_ref.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot a Reference CCF</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Plot an interferogram">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_plot_interferogram.py`

.. raw:: html

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


.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_ref
   /auto_examples/plot_interferogram


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