File: index.rst

package info (click to toggle)
ccdproc 2.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,132 kB
  • sloc: python: 5,554; makefile: 112
file content (71 lines) | stat: -rw-r--r-- 1,637 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
70
71
.. 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>

=======
ccdproc
=======

.. raw:: html

   <img src="_static/ccdproc_banner.svg" onerror="this.src='_static/ccdproc_banner.png'; this.onerror=null;" width="495"/>

.. only:: latex

    .. image:: _static/ccdproc_banner.pdf

**Ccdproc** is is an `Astropy`_ `affiliated package
<https://www.astropy.org/affiliated/index.html>`_  for basic data reductions
of CCD images. It provides the essential tools for processing of CCD images
in a framework that provides error propagation and bad pixel tracking
throughout the reduction process.

.. Important::
    If you use `ccdproc`_ 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>`.

Detailed, step-by-step guide
----------------------------

In addition to the documentation here, a detailed guide to the topic of CCD
data reduction using ``ccdproc`` and other `astropy`_ tools is available here:
https://mwcraig.github.io/ccd-as-book/00-00-Preface

Getting started
---------------

.. toctree::
    :maxdepth: 1

    install
    overview
    getting_started
    citation
    contributing
    conduct
    authors_for_sphinx
    changelog
    license

Using `ccdproc`
---------------

.. toctree::
    :maxdepth: 2

    ccddata
    image_combination
    reduction_toolbox
    image_management
    reduction_examples
    default_config

.. toctree::
    :maxdepth: 1

    api