Examples
========

The repository includes an example spectrum at:

.. code-block:: text

   examples/example_spectra.txt

You can also download the bundled input spectrum directly:

:download:`Download example_spectra.txt <../examples/example_spectra.txt>`

Run the example script from the project root:

.. code-block:: bash

   python examples/run_example.py

The script writes:

.. code-block:: text

   examples/example_components.csv
   examples/example_fit.png

The example output plot is shown below as a reference for a successful fit:

.. image:: ../examples/example_fit.png
   :alt: Diagnostic Gaussian fit for the bundled example spectrum
   :align: center
   :width: 90%

The fitted component table is written by the example script to:

.. code-block:: text

   examples/example_components.csv