.. AstroToolkit documentation master file, created by
   sphinx-quickstart on Tue Aug 13 00:12:35 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

AstroToolkit Documentation
==========================

AstroToolkit (ATK) is a set of tools for fetching, plotting, and analysing astronomical data. The package is in active development, so please report any issues/suggestions/contributions on `GitHub <https://github.com/WD-planets/AstroToolkit>`_.

|

Features
--------
- A GUI through which most of the package can be utilised
- Command-line integration
- Scripting integration for greater control
- Proper motion correction through Gaia, utilised across the entire package
- Light curve, spectral energy distribution, spectrum and image queries from a wide range of surveys
- Gaia HRD queries for any Gaia sources
- In-built interactive plotting support for all of the above as shareable .html pages that retain all interactivity
- Data queries from any `Vizier <https://vizier.cds.unistra.fr/>`_ survey, with many commonly used surveys built-in
- Reddening queries from `Stilism  <https://stilism.obspm.fr/>`_ and `GDRE <https://irsa.ipac.caltech.edu/applications/DUST/>`_
- Data analysis tools:
    
    - Timeseries analysis using a variety of methods (Lomb-Scargle, AOVMHW, ...)
    - Light curve binning, clipping, phase folding and sigma-clipping
    - Image detection and tracer overlays
    - Spectral band highlighting
    - SED-spectrum overlays
    - Data quality filtering (optional)

- Lossless saving and reading of any ATK data structures to / from local files
- Datapage creation, allowing the combination of any of the above into a single page with additional elements specifically designed for this purpose
- No hard coded parameters - built-in configuration support allows the user to personalise the package to their specific needs.
- All data structures are available to the user, allowing them to use all ATK routines on non-ATK data
- Other quality-of-life tools, such as coordinate conversions, .fits file reading and `Vizier <https://vizier.cds.unistra.fr/>`_ / `SIMBAD <https://simbad.u-strasbg.fr/simbad/>`_ searches

|

Acknowledgements
----------------
This project has received funding from the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (Grant agreement No. 101020057).

.. image:: images/erc_logo_light.png
   :scale: 15%
   :align: center

|

I would like to give thanks to Dr. Keith Inight for his guidance at various stages of the package's development. I would also like to give thanks to Prof. Boris Gänsicke for his assistance and guidance, and for supporting the package's development.

|

.. toctree::
   :titlesonly:
   :hidden:
   :caption: Tutorials

   Tutorial/section_getting_started
   Tutorial/section_configuration
   Tutorial/Tutorial_models
   Tutorial/Tutorial_datapage
   Tutorial/Tutorial_gui

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Modules
    
   Modules/modules

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Data Structures

   DataStructures/datastructures 

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Information

   Information/supported_surveys
   Misc/configkeys
   Commandline/commandline