.. easyspec documentation master file, created by
   sphinx-quickstart on Mon Mar 24 13:20:42 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to easyspec's documentation!
====================================

.. image:: ./logo.png
  :width: 700
  
Tutorials
---------

The instructions on how to use `easyspec <https://github.com/ranieremenezes/easyspec/tree/main>`_ can be found in the GitHub directory "Tutorials".

The main tutorials are:

* `Image_cleaning_easyspec <https://github.com/ranieremenezes/easyspec/blob/main/tutorial/Image_cleaning_easyspec.ipynb>`_: here we will guide you on how to reduce raw long-slit spectroscopic data, i.e., we will show you how to trim, debias, dedark, flatten, remove the cosmic rays, and stack the data.
* `spectroscopy_tracing_easyspec <https://github.com/ranieremenezes/easyspec/blob/main/tutorial/spectroscopy_tracing_easyspec.ipynb>`_: here we will show you how to extract your spectra and calibrate them in wavelegnth and flux.
* `spectral_analysis_easyspec <https://github.com/ranieremenezes/easyspec/blob/main/tutorial/spectral_analysis_easyspec.ipynb>`_: finally, we show you how to fit a model to each line of your spectrum with a MCMC approach and recover physical quantities such as redshift, dispersion velocity, FWHM, line flux and many more.

For more advanced analyses, we recommend the tutorials

* `spectral_analysis_fitting_a_line_with_two_Gaussians <https://github.com/ranieremenezes/easyspec/blob/main/tutorial/spectral_analysis_fitting_a_line_with_two_Gaussians.ipynb>`_: here we fit the H :math:`{\beta}` line with two Gaussian components and also explore the MCMC posterior distributions.

* `asymmetrical\_lines\_easyspec <https://github.com/ranieremenezes/easyspec/blob/main/tutorial/asymmetrical_lines_easyspec.ipynb>`_: here, we fit a skewed Lorentzian model to a C IV emission line, demonstrate how to construct a synthetic spectrum, and show how to manually define MCMC priors. 

* `Stacking\_reduced\_spectra <https://github.com/ranieremenezes/easyspec/blob/main/tutorial/Stacking_reduced_spectra.ipynb>`_: In this tutorial, we show how to stack multiple spectra of the same target obtained with different instruments, spectral resolutions, and wavelength coverages.

Contents
--------

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   data_cleaning
   line_models
   modules