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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
.. _docroot:
##########
Specreduce
##########
| **Version**: |release|
| **Date**: |today|
:ref:`Specreduce <docroot>` is an `Astropy <https://www.astropy.org>`_
`coordinated package <https://www.astropy.org/affiliated/>`_ that
provides a toolkit for reducing optical and infrared spectroscopic data. It
offers the building blocks for basic spectroscopic reduction, and is designed to serve as a
foundation upon which instrument-specific pipelines and analysis tools can be built.
Specreduce includes tools for determining and modeling spectral traces, performing
background subtraction, extracting one-dimensional spectra using both optimal and boxcar methods,
and applying wavelength correction derived from calibration data.
Beyond these tasks, basic image processing steps, data analysis, and visualisation are covered by
other Astropy ecosystem packages like `ccdproc <https://ccdproc.readthedocs.io/en/latest/>`_,
`specutils <https://specutils.readthedocs.io/en/latest/>`_, and
`matplotlib <https://matplotlib.org/>`_. The documentation includes examples demonstrating how these
tools can be combined to create complete spectroscopic workflows.
.. image::
roadmap.png
.. note::
Specreduce is an active, community-driven project, and we warmly welcome contributions of all kinds,
from reporting bugs and suggesting new features to improving documentation or writing code.
Whether you are an experienced developer or just getting started, your input helps make Specreduce
better for everyone. If you would like to get involved, see the :ref:`contributor's guide
<contributors_guide>` for details on how to participate and become part of the wider Astropy
community.
.. toctree::
:maxdepth: 1
:hidden:
getting_started/index
user_guide.rst
contributing.rst
api.rst
.. grid:: 2
:gutter: 2 3 4 4
.. grid-item-card::
:text-align: center
**Getting Started**
^^^^^^^^^^^^^^^^^^^
New to Specreduce? Check out the getting started guides.
+++
.. button-ref:: getting_started/index
:expand:
:color: primary
:click-parent:
To the getting started guides
.. grid-item-card::
:text-align: center
**User Guide**
^^^^^^^^^^^^^^
The user guide provides in-depth information on the key concepts
of Specreduce with useful background information and explanation.
+++
.. button-ref:: user_guide
:expand:
:color: primary
:click-parent:
To the user guide
.. grid-item-card::
:text-align: center
**API Reference**
^^^^^^^^^^^^^^^^^
The API reference contains a detailed description of the
functions, modules, and objects included in Specreduce. It
assumes that you have an understanding of the key concepts.
+++
.. button-ref:: api
:expand:
:color: primary
:click-parent:
To the API reference
.. grid-item-card::
:text-align: center
**Contributor's Guide**
^^^^^^^^^^^^^^^^^^^^^^^
Want to contribute to Specreduce? Found a bug? The contributing guidelines will
show you how to improve specreduce.
+++
.. button-ref:: contributing
:expand:
:color: primary
:click-parent:
To the contributor's guide
|
