File: README.rst

package info (click to toggle)
ccdproc 1.3.0-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 2,512 kB
  • sloc: python: 10,251; makefile: 117; ansic: 88
file content (69 lines) | stat: -rw-r--r-- 3,292 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
ccdproc
=======

.. image:: https://travis-ci.org/astropy/ccdproc.svg?branch=master
  :target: https://travis-ci.org/astropy/ccdproc

.. image:: https://coveralls.io/repos/astropy/ccdproc/badge.svg
  :target: https://coveralls.io/r/astropy/ccdproc
  
.. image:: https://zenodo.org/badge/12153/astropy/ccdproc.svg
   :target: https://zenodo.org/badge/latestdoi/12153/astropy/ccdproc


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
<http://ccdproc.readthedocs.io/en/latest/>`_

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`_ or 
`@mwcraig`_ .  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`_ or 
`@crawfordsm`_. 

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.

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 <http://adsabs.harvard.edu/abs/2015ascl.soft10007C>`_

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

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