.. sed-analysis-tools documentation master file, created by
   sphinx-quickstart on Thu Nov 14 16:51:42 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to sed-analysis-tools's documentation!
==============================================

Fitting and analysing stellar spectral energy distributions (SEDs) for single and multi-component systems assuming blackbody modelling. 

* Test the recoverability of a single/binary system for a give set of filters
* Estimate the lower limit to the SED errors
* Ability to use real filter transmission curves


Installation
~~~~~~~~~~~~

.. code-block::

   pip install sed_analysis_tools

**GitHub**: `sed-analysis-tools <https://github.com/jikrant3/sed-analysis-tools/>`__

* Requirements

``python`` >= 3.10,
``astropy`` >= 6.0,
``matplotlib`` >= 3.7,
``numpy`` >= 1.24,
``pandas`` >= 2.0,
``scipy`` >= 1.12,
``tqdm`` >= 1.12

* The module will download models (e.g. isochrones) and filter transmission curves as required into a `$HOME/.sed_analysis_tools` (or equivalent) folder.

Basic working
~~~~~~~~~~~~~

SED fitting using blackbody modelling

.. image:: guide_Binary/output_8_0.png

Understanding the recoverability of binary system using SED for a given filter set and noise levels.

.. image:: guide_error_estimation/demo_hrd_grid.jpg

Estimating SED fitting errors assuming blackbody approximation. And visualizing the possible degeneracy due to nearby secondaries resulting in similar HRD position.

.. image:: guide_error_estimation/error_estimation.png




Citing sed_analysis_tools
~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.14166044.svg
  :target: https://doi.org/10.5281/zenodo.14166044

This code is developed by Vikrant V. Jadhav (Universität Bonn).

If you use the code, please cite the `Zenodo repository <https://doi.org/10.5281/zenodo.14166044>`__ and Jadhav et al. (2025, under rewiew), *On the detectability and parameterisation of binary stars through spectral energy distributions*, 
Journal of Astrophysics and Astronomy

.. code-block:: latex

   @software{jikrant3_2024_14166044,
   author       = {{Jadhav}, Vikrant V.},
   title        = {jikrant3/sed-analysis-tools},
   month        = Nov,
   year         = 2024,
   publisher    = {Zenodo},
   version      = {v1.2.0},
   doi          = {10.5281/zenodo.14166044},
   url          = {https://doi.org/10.5281/zenodo.14166044}
   }


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Home <self>
   getting_started
   modules
   changelog


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`