ccdproc
=======

.. image:: https://github.com/astropy/ccdproc/workflows/CI/badge.svg
    :target: https://github.com/astropy/ccdproc/actions
    :alt: GitHub Actions CI Status

.. image:: https://coveralls.io/repos/astropy/ccdproc/badge.svg
  :target: https://coveralls.io/r/astropy/ccdproc

.. image:: https://zenodo.org/badge/13384007.svg
   :target: https://zenodo.org/badge/latestdoi/13384007


Ccdproc is is an affiliated package for the AstroPy package for basic data
reductions of CCD images.   The ccdproc  package provides many of the
necessary tools for processing of ccd images built on a framework to provide
error propagation and bad pixel tracking throughout the reduction process.

Ccdproc can currently be installed via pip or from the source code.  For
installation instructions, see the `online documentation`_ or docs/install.rst
in this source distribution.


Documentation is at `ccdproc.readthedocs.io
<https://ccdproc.readthedocs.io/en/latest/>`_

An extensive `tutorial`_ is currently in development.

Contributing
------------

We have had the first stable release, but there is still plenty to do!

Please open a new issue or new pull request for bugs, feedback, or new features
you would like to see.   If there is an issue you would like to work on, please
leave a comment and we will be happy to assist.   New contributions and
contributors are very welcome!

New to github or open source projects?  If you are unsure about where to start
or haven't used github before, please feel free to email `@crawfordsm`_,
`@mwcraig`_ or `@mseifert`_.  We will more than happily help you make your first
contribution.

Feedback and feature requests?   Is there something missing you would like
to see?  Please open an issue or send an email to  `@mwcraig`_,
`@crawfordsm`_ or `@mseifert`_.   Questions can also be opened on
stackoverflow, twitter, or the astropy email list.

Ccdproc follows the `Astropy Code of Conduct`_ and strives to provide a
welcoming community to all of our users and contributors.

Want more information about how to make a contribution?  Take a look at
the astropy `contributing`_ and `developer`_ documentation.

If you are interested in finacially supporting the project, please
consider donating to `NumFOCUS`_ that provides financial
management for the Astropy Project.

Acknowledgements
----------------

If you have found ccdproc useful to your research, please considering adding a
citation to `ccdproc contributors;  Craig, M. W.; Crawford, S. M.; Deil, Christoph; Gasdia, Forrest; Gomez, Carlos;  Günther, Hans Moritz;  Heidt, Nathan; Horton,  Anthony;  Karr, Jennifer;  Nelson, Stefan; Ninan, Joe Phillip;  Pattnaik, Punyaslok; Rol, Evert; Schoenell, William; Seifert, Michael; Singh, Sourav; Sipocz, Brigitta; Stotts, Connor; Streicher, Ole;  Tollerud, Erik; and Walker, Nathan, 2015,  Astrophysics Source Code Library, 1510.007, DOI: 10.5281/zenodo.47652 <https://ui.adsabs.harvard.edu/abs/2015ascl.soft10007C>`_

Thanks to Kyle Barbary (`@kbarbary`_) for designing the `ccdproc` logo.

.. _Astropy: https://www.astropy.org/
.. _git: https://git-scm.com/
.. _github: https://github.com
.. _Cython: https://cython.org/
.. _online documentation: https://ccdproc.readthedocs.io/en/latest/install.html
.. _@kbarbary: https://github.com/kbarbary
.. _@crawfordsm: https://github.com/crawfordsm
.. _@mwcraig: https://github.com/mwcraig
.. _@mseifert: https://github.com/MSeifert04
.. _Astropy Code of Conduct:  https://www.astropy.org/about.html#codeofconduct
.. _contributing: https://docs.astropy.org/en/stable/index.html#contributing
.. _developer: https://docs.astropy.org/en/stable/index.html#developer-documentation
.. _tutorial: https://github.com/mwcraig/ccd-reduction-and-photometry-guide
.. _NumFOCUS: https://numfocus.org/
