.. X-ray: Generate and Analyse (XGA) documentation master file, created by
   sphinx-quickstart on Thu Dec 17 12:18:33 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to X-ray: Generate and Analyse (XGA)'s documentation!
===========================================================
.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Introduction <intro.rst>
   Installation <install.rst>
   Tutorials <tutorials.rst>
   Advanced Tutorials <advanced_tutorials.rst>
   XGA Pipelines <pipeline_tutorials.rst>
   Under the Hood <techniques.rst>
   XGA's Parallelism <parallelism.rst>
   XGA Classes and Functions <xga.rst>
   Planned Features <future.rst>
   Publications using XGA <publications.rst>
   Getting Support <support.rst>


.. code-block::
   :caption: If you make use of XGA in academic work, please cite the following software paper and ASCL entry
   :name: BibTeX Reference

   @ARTICLE{2022arXiv220201236T,
          author = {{Turner}, D.~J. and {Giles}, P.~A. and {Romer}, A.~K. and {Korbina}, V.},
           title = "{XGA: A module for the large-scale scientific exploitation of archival X-ray astronomy data}",
         journal = {arXiv e-prints},
        keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Cosmology and Nongalactic Astrophysics, Astrophysics - Astrophysics of Galaxies, Astrophysics - High Energy Astrophysical Phenomena},
            year = 2022,
           month = feb,
             eid = {arXiv:2202.01236},
           pages = {arXiv:2202.01236},
   archivePrefix = {arXiv},
          eprint = {2202.01236},
    primaryClass = {astro-ph.IM},
          adsurl = {https://ui.adsabs.harvard.edu/abs/2022arXiv220201236T},
         adsnote = {Provided by the SAO/NASA Astrophysics Data System}
   }

   @MISC{xgaascl,
       author = {{Turner}, D.~J. and {Giles}, P.~A. and {Romer}, A.~K. and {Korbina}, V.},
        title = "{XGA: Efficient analysis of XMM observations}",
     keywords = {Software},
   howpublished = {Astrophysics Source Code Library, record ascl:2301.012},
         year = 2023,
        month = jan,
          eid = {ascl:2301.012},
        pages = {ascl:2301.012},
   archivePrefix = {ascl},
       eprint = {2301.012},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2023ascl.soft01012T},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
   }