.. _sphx_glr_generated_gallery_user_guide:

User Guide
==========

Examples of how to use fiasco to parse CHIANTI data and compute derived quantities.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to calculate the contribution function of a particular transition of O VI as a function of temperature at a given density.">

.. only:: html

  .. image:: /generated/gallery/user_guide/images/thumb/sphx_glr_plot_contribution_function_thumb.png
    :alt:

  :doc:`/generated/gallery/user_guide/plot_contribution_function`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Calculating a contribution function</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to create a Ion object and access various pieces of metadata.">

.. only:: html

  .. image:: /generated/gallery/user_guide/images/thumb/sphx_glr_ion_metadata_thumb.png
    :alt:

  :doc:`/generated/gallery/user_guide/ion_metadata`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating an Ion</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to create an IonCollection object.">

.. only:: html

  .. image:: /generated/gallery/user_guide/images/thumb/sphx_glr_ion_collection_thumb.png
    :alt:

  :doc:`/generated/gallery/user_guide/ion_collection`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating an IonCollection</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to compute the recombination rate as a function of temperature for Fe 16, including the radiative and dielectronic components.">

.. only:: html

  .. image:: /generated/gallery/user_guide/images/thumb/sphx_glr_plot_recomb_rate_thumb.png
    :alt:

  :doc:`/generated/gallery/user_guide/plot_recomb_rate`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Ionization and recombination rates</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to compute the ionization fraction as a function of temperature, assuming equilibrium, for both a single ion as well as a whole element.">

.. only:: html

  .. image:: /generated/gallery/user_guide/images/thumb/sphx_glr_plot_ionization_fraction_thumb.png
    :alt:

  :doc:`/generated/gallery/user_guide/plot_ionization_fraction`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Ionization fractions in equilibrium</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we&#x27;ll show how to compute the ionization fractions of iron in the case where the the timescale of the temperature change is shorter than the ionization timescale. This is often referred to as non-equilibrium ionization.">

.. only:: html

  .. image:: /generated/gallery/user_guide/images/thumb/sphx_glr_nei_populations_thumb.png
    :alt:

  :doc:`/generated/gallery/user_guide/nei_populations`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Non-equilibrium Ionization</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to directly parse the raw CHIANTI database files.">

.. only:: html

  .. image:: /generated/gallery/user_guide/images/thumb/sphx_glr_parse_raw_data_thumb.png
    :alt:

  :doc:`/generated/gallery/user_guide/parse_raw_data`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Parsing Raw CHIANTI Data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we will use the aiapy package to convolve the Fe XVIII contribution function with the instrument response function to understand the temperature sensitivity of the 94 angstrom channel.">

.. only:: html

  .. image:: /generated/gallery/user_guide/images/thumb/sphx_glr_aia_response_thumb.png
    :alt:

  :doc:`/generated/gallery/user_guide/aia_response`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Understanding AIA temperature response with aiapy</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /generated/gallery/user_guide/plot_contribution_function
   /generated/gallery/user_guide/ion_metadata
   /generated/gallery/user_guide/ion_collection
   /generated/gallery/user_guide/plot_recomb_rate
   /generated/gallery/user_guide/plot_ionization_fraction
   /generated/gallery/user_guide/nei_populations
   /generated/gallery/user_guide/parse_raw_data
   /generated/gallery/user_guide/aia_response