.. the "raw" directive below is used to hide the title in favor of
   just the logo being visible
.. raw:: html

    <style media="screen" type="text/css">
      h1 {display:none;}
    </style>

.. |br| raw:: html

    <div style="min-height:0.1em;"></div>

*********
AstroPhot
*********

.. image:: https://github.com/Autostronomy/AstroPhot/blob/main/media/AP_logo.png?raw=true
   :width: 100 %
   :target: https://github.com/Autostronomy/AstroPhot
   
|br|

.. Important::
    If you use AstroPhot for a project that leads to a publication,
    whether directly or as a dependency of another package, please
    include an :doc:`acknowledgment and/or citation <citation>`.

|br|

Getting Started
===============

AstroPhot is a fast, flexible, and automated astronomical image modelling tool for precise parallel multi-wavelength photometry.
Its pythonic design allows for fast startup and provides flexibility to explore new ideas and support advanced users.
It was written by `Connor Stone <https://connorjstone.com/>`_ .

This documentation is a work in progress, further updates will come.

.. toctree::
    :maxdepth: 1

    install.rst
    getting_started.rst
    tutorials.rst
    coordinates.rst
    troubleshooting.rst
    citation.rst

User Documentation
==================

This documentation includes all functions available in the AstroPhot package. For now it is somewhat scattered, the best way to navigate it is to search for the kind of function or model you are looking for. Further organization will come with future updates.

.. toctree::
    :maxdepth: 1

    modules.rst
    configfile_interface.rst
    license.rst   
    contributing.rst
              
|br|

.. note::

    Like much astronomy software, AstroPhot is an evolving package.
    I try to keep the API stable and consistent, however I will make
    changes to the interface if it considerably improves things
    going forward. Please contact connorstone628@gmail.com if you experience
    issues. If you would like to be notified of major changes send an email
    with the subject line "ASTROPHOT MAILING LIST".