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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
.. Astropy documentation index file, created by
sphinx-quickstart on Tue Jul 26 02:59:34 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
:tocdepth: 3
.. 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>
#####################
Astropy Documentation
#####################
.. |logo_svg| image:: _static/astropy_banner.svg
.. |logo_png| image:: _static/astropy_banner_96.png
.. raw:: html
<img src="_static/astropy_banner.svg" onerror="this.src='_static/astropy_banner_96.png'; this.onerror=null;" width="485"/>
.. only:: latex
.. image:: _static/astropy_logo.pdf
The ``astropy`` package contains key functionality and common tools needed for
performing astronomy and astrophysics with Python. It is at the core of the
`Astropy Project <http://www.astropy.org/about.html>`_, which aims to enable
the community to develop a robust ecosystem of `affiliated packages`_
covering a broad range of needs for astronomical research, data
processing, and data analysis.
.. Important:: If you use Astropy for work presented in a publication or talk
please help the project via proper `citation or acknowledgement
<https://www.astropy.org/acknowledging.html>`_. This also applies to use of
software or `affiliated packages`_ that depend on the astropy
core package.
.. _getting-started:
***************
Getting Started
***************
.. toctree::
:maxdepth: 1
install
whatsnew/5.2
importing_astropy
Example Gallery <generated/examples/index>
Tutorials <https://learn.astropy.org/>
Get Help <http://www.astropy.org/help.html>
Contribute and Report Problems <http://www.astropy.org/contribute.html>
About the Astropy Project <http://www.astropy.org/about.html>
.. _user-docs:
******************
User Documentation
******************
Data structures and transformations
-----------------------------------
.. toctree::
:maxdepth: 1
constants/index
units/index
nddata/index
table/index
time/index
timeseries/index
coordinates/index
wcs/index
modeling/index
uncertainty/index
Files, I/O, and Communication
-----------------------------
.. toctree::
:maxdepth: 1
io/unified
io/fits/index
io/ascii/index
io/votable/index
io/misc
samp/index
Computations and utilities
--------------------------
.. toctree::
:maxdepth: 1
cosmology/index
convolution/index
utils/iers
visualization/index
stats/index
Nuts and bolts
--------------
.. toctree::
:maxdepth: 1
config/index
io/registry
logging
warnings
utils/index
glossary
.. _developer-docs:
***********************
Developer Documentation
***********************
The developer documentation contains instructions for how to contribute to
Astropy or affiliated packages, install and test the development version,
as well as coding, documentation, and testing guidelines.
{% if is_development %}
For the guiding vision of this process and the project
as a whole, see :doc:`development/vision`.
.. toctree::
:maxdepth: 1
development/workflow/development_workflow
development/workflow/virtual_pythons
development/workflow/get_devel_version
development/when_to_rebase
development/codeguide
development/docguide
development/style-guide
development/testguide
testhelpers
development/scripts
development/building
development/ccython
development/releasing
development/workflow/maintainer_workflow
development/astropy-package-template
changelog
There are some additional tools, mostly of use for maintainers, in the
`astropy/astropy-tools repository
<https://github.com/astropy/astropy-tools>`__.
{%else%}
To read the developer documentation, you will need to go to the :ref:`latest
developer version of the documentation
<astropy-dev:developer-docs>`.
.. toctree::
:maxdepth: 1
changelog
{%endif%}
.. _project-details:
***************
Project details
***************
.. toctree::
:maxdepth: 1
whatsnew/index
lts_policy
known_issues
credits
license
*****
Index
*****
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _feedback@astropy.org: mailto:feedback@astropy.org
.. _affiliated packages: https://www.astropy.org/affiliated/
|
