.. asgardpy documentation master file, created by
   sphinx-quickstart on Tue Sep 21 08:07:48 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root toctree directive.

**asgardpy pipeline**
=====================

Gammapy-based pipeline to support high-level analysis for multi-instruments joint datasets.
Follow the `Gammapy v1.3 <https://docs.gammapy.org/1.3/>`_ documentation for understanding the core Gammapy objects.

The various Data Levels used here follow the descriptions suggested by
`GADF v0.3 <https://gamma-astro-data-formats.readthedocs.io/en/latest/>`_ and `CTAO <https://www.ctao.org/>`_ Data Model.

The pipeline was developed with first testing with Fermi-LAT (`enrico <https://enrico.readthedocs.io/en/latest/>`_ and
`fermipy <https://fermipy.readthedocs.io/en/latest/>`_) files and LST-1 (`cta-lstchain <https://cta-observatory.github.io/cta-lstchain/>`_)
DL3 files (with energy-dependent and global selection cuts) for point-like sources.

It also allows for a preliminary analysis of HAWC datasets (stored in Gammapy-readable data). The pipeline can be further expanded to support more types of DL3 files of gamma-ray instruments.
See some example notebooks and tests, which use the public data used in Gammapy Tutorials, with an additional Fermi-LAT data.

See :doc:`need_for_asgardpy` for a brief overview of the pipeline and its future and :doc:`crab_sed` for an extended example of the usage of the pipeline.


GitHub Repository: https://github.com/chaimain/asgardpy

.. _introduction:

.. toctree::
   :maxdepth: 2
   :caption: Introduction
   :name: _introduction

   overview
   additional_dataset_input
   additional_model_input
   additional_stats
   need_for_asgardpy
   crab_sed
   installation

.. _changes:

.. toctree::
   :maxdepth: 2
   :caption: Changelogs
   :name: _changes

   changelog

.. _api:

.. toctree::
   :maxdepth: 1
   :caption: API Documentation
   :name: _api

   _api_docs/index

.. toctree::
  :hidden:
  :caption: Development

  License <https://github.com/chaimain/asgardpy/blob/main/LICENSE>
  CODE_OF_CONDUCT
  CONTRIBUTING
  GitHub Repository <https://github.com/chaimain/asgardpy>
  Issue Tracker <https://github.com/chaimain/asgardpy/issues>


Team
----

**asgardpy** is developed and maintained by `Chaitanya Priyadarshi <https://github.com/chaimain>`_.
To learn more about who specifically contributed to this codebase, see
`our contributors <https://github.com/chaimain/asgardpy/graphs/contributors>`_ page.


Cite
----

If you use Asgardpy in a publication, please cite the exact version you used from Zenodo *Cite as* https://doi.org/10.5281/zenodo.8106369


License
-------

**asgardpy** is licensed under `Apache 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.
A full copy of the license can be found on `GitHub <https://github.com/chaimain/asgardpy/blob/main/LICENSE>`_.

Indices and tables
------------------

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


Dependencies
------------

* `astropy <https://www.astropy.org>`_ managing physical units and astronomical distances;

* `gammapy <https://gammapy.org/>`_ for main high-level analysis