Stellarphot is a package for performing photometry on calibrated (reduced) astronomical images. It
provides a simple interface for performing aperture photometry of either a single
image or a directory with multiple images. It is designed to be easy to use for both
non-programmers and programmers.


.. grid:: 1 1 2 2

    .. grid-item-card::
        :padding: 2
        :text-align: center

        **Testing stellarphot?**
        ^^^

        Are you testing a pre-relase version of stellarphot?
        There are special installation instructions for you.

        .. button-ref:: dev/testing_installation
            :expand:
            :color: primary
            :click-parent:

            To the pre-release testing instructions

    .. grid-item-card::
        :padding: 2
        :text-align: center

        **Getting Started?**
        ^^^

        Installation instructions and a walk though of the process of doing photometry.

        .. button-ref:: stellarphot/getting_started
            :expand:
            :color: primary
            :click-parent:

            To the Getting Started guide


    .. grid-item-card::
        :padding: 2
        :text-align: center

        **User guide**
        ^^^

        A guide to using stellarphot, including how to make settings and perform photometry.

        .. button-ref:: stellarphot/user_guide/index
            :expand:
            :color: primary
            :click-parent:

            To the user guide

    .. grid-item-card::
        :padding: 2
        :text-align: center

        **Reference**
        ^^^

        Detailed descriptions of every class and function in stellarphot.

        .. button-ref:: stellarphot/api_reference
            :expand:
            :color: primary
            :click-parent:

            To the API reference

    .. grid-item-card::
        :padding: 2
        :text-align: center

        **Contributing**
        ^^^

        Thanks for your interest in contributing to stellarphot. Click here to learn how to get started.

        .. button-ref:: dev/index
            :expand:
            :color: primary
            :click-parent:

            To the contributing guide

.. toctree::
  :maxdepth: 1
  :hidden:

  stellarphot/getting_started.rst
  stellarphot/user_guide/index.rst
  stellarphot/settings.rst
  stellarphot/api_reference.rst
  dev/index.rst