:orphan:

.. _examples:

Examples
========

This is a collection of examples to demonstrate how to use pysecs.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates the resulting angular profile of an SECS pole placed at the north pole. Figure 2 from Amm and Viljanen 1999.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_plot_B_divergence_free_thumb.png
    :alt:

  :ref:`sphx_glr_examples_plot_B_divergence_free.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Divergence free magnetic field</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates the resulting current surfaces from the curl-free and divergence-free SEC poles.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_plot_J_surface_thumb.png
    :alt:

  :ref:`sphx_glr_examples_plot_J_surface.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to fit generic B observation inputs and fit an SECS system to make predictions on a separate grid and compare the results.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_plot_animation_thumb.gif
    :alt:

  :ref:`sphx_glr_examples_plot_animation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Fitting B time series (animation)</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /examples/plot_B_divergence_free
   /examples/plot_J_surface
   /examples/plot_animation


.. 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: examples_python.zip </examples/examples_python.zip>`

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

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


.. only:: html

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

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