Detailled examples
===================

This page lists the different Jupyter notebook included in this package written to check
each and every implemented feature.

+-----------------------------------------+----------------------------------------------------------------------------+
| examples/01_specdata_read_plot_extract  |  Testing the I/O methods of the package                                    |
+-----------------------------------------+----------------------------------------------------------------------------+
|                                         | - Instantiate a SpecModel object and use its base plot method              |
|              `Case 101`_                | - Instantiate multiple SpecModels objects and use its                      |
|                                         | - its base plot method to create a combined plot.                          |
+-----------------------------------------+----------------------------------------------------------------------------+
|                                         | - Instantiate a SpecModel object,                                          |
|              `Case 102`_                | - Identify a spectral feature,                                             |
|                                         | - Extract it and return it as a new SpecModel object.                      |
+-----------------------------------------+----------------------------------------------------------------------------+
+-----------------------------------------+----------------------------------------------------------------------------+
| examples/02_specdata_read_plot_fit      |  Testing the fittings methods of the package                               |
+-----------------------------------------+----------------------------------------------------------------------------+
|                                         | - Instantiate a SpecModel object, and                                      |
|              `Case 201`_                | - Fit its whole, or parts of its, continuum using polynomial functions,    |
|                                         | - Overplot the data with the best fitting results.                         |
+-----------------------------------------+----------------------------------------------------------------------------+
|                                         |  - Instantiate a SpecModel object, identify a spectral                     |
|              `Case 202`_                |    feature, extract and return it as a new SpecModel object.               |
|                                         |  - Fit the new SpecModel object with a simple curve and                    |
|                                         |    overplot the data with the best-fitting results.                        |
+-----------------------------------------+----------------------------------------------------------------------------+



.. _Case 101: ./../../../../examples/01_specdata_read_plot_extract/case101_read_plot.ipynb
.. _Case 102: ./../../../../examples/02_specdata_read_plot_extract/case102_read_extract.ipynb
.. _Case 201: ./../../../../examples/02_specdata_read_plot_fit/case201_read_fit_continuum.ipynb
.. _Case 202: ./../../../../examples/02_specdata_read_plot_fit/case202_read_fit_band.ipynb