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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
******************************
Current status of sub-packages
******************************
Astropy has benefited from the addition of widely tested legacy code, as well
as new development, resulting in variations in stability across
sub-packages. This document summarizes the current status of the Astropy
sub-packages, so that users understand where they might expect changes in
future, and which sub-packages they can safely use for production code.
The classification is as follows:
.. raw:: html
<style>
.planned:before {
color: #cbcbcb;
content: "⬤";
}
.dev:before {
color: #ffad00;
content: "⬤";
}
.stable:before {
color: #4e72c3;
content: "⬤";
}
.mature:before {
color: #03a913;
content: "⬤";
}
.pendingdep:before {
color: #a84b03;
content: "⬤";
}
.deprecated:before {
color: #ff0000;
content: "⬤";
}
</style>
<table align='center'>
<tr>
<td align='center'><span class="planned"></span></td>
<td>Planned</td>
</tr>
<tr>
<td align='center'><span class="dev"></span></td>
<td>Actively developed, be prepared for possible significant changes.</td>
</tr>
<tr>
<td align='center'><span class="stable"></span></td>
<td>Reasonably stable, any significant changes/additions will generally include backwards-compatiblity.</td>
</tr>
<tr>
<td align='center'><span class="mature"></span></td>
<td>Mature. Additions/improvements possible, but no major changes planned. </td>
</tr>
<tr>
<td align='center'><span class="pendingdep"></span></td>
<td>Pending deprecation. Might be deprecated in a future version.</td>
</tr>
<tr>
<td align='center'><span class="deprecated"></span></td>
<td>Deprecated. Might be removed in a future version.</td>
</tr>
</table>
The current planned and existing sub-packages are:
.. raw:: html
<table border="1" class="docutils stability" align='center'>
<tr>
<th class="head">
Sub-Package
</th>
<th class="head">
</th>
<th class="head">
Comments
</th>
</tr>
<tr>
<td>
astropy.config
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
Configuration received major overhaul in v0.4. Since then on, the package has been stable.
</td>
</tr>
<tr>
<td>
astropy.constants
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
The package has been stable except for the occasional additions of new constants. Since v3.0, it includes the ability to use sets of constants from previous versions.
</td>
</tr>
<tr>
<td>
astropy.convolution
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
New top-level package in v0.3 (was previously part of
<tt class="docutils literal"><span class="pre">astropy.nddata</span></tt>).
A major consistency improvement between fft/non-fft convolution, which is not fully backward-compatible, was added in 2.0.
</td>
</tr>
<tr>
<td>
astropy.coordinates
</td>
<td align='center'>
<span class="stable"></span>
</td>
<td>
New in v0.2, major changes in v0.4. Subsequent versions should
maintain a stable/backwards-compatible API, following the plan of <a href="https://github.com/astropy/astropy-APEs/blob/master/APE5.rst">APE 5</a>. Further major additions/enhancements likely, but with basic framework unchanged.
</td>
</tr>
<tr>
<td>
astropy.cosmology
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
Incremental improvements since v0.1, stable API last several versions.
</td>
</tr>
<tr>
<td>
astropy.io.ascii
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
Originally developed as <tt class="docutils literal"><span class="pre">asciitable</span></tt>, and has maintained a stable API.
</td>
</tr>
<tr>
<td>
astropy.io.fits
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
Originally developed as <tt class="docutils literal"><span class="pre">pyfits</span></tt>, and retains an API consistent with the standalone version.
</td>
</tr>
<tr>
<td>
astropy.io.misc
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
The functionality that is currently present is stable, but this sub-package will likely see major additions in future.
</td>
</tr>
<tr>
<td>
astropy.io.votable
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
Originally developed as <tt class="docutils literal"><span class="pre">vo.table</span></tt>, and has a stable API.
</td>
</tr>
<tr>
<td>
astropy.modeling
</td>
<td align='center'>
<span class="dev"></span>
</td>
<td>
New in v0.3. Major changes in v1.0, significant additions planned. Backwards-compatibility likely to be maintained, but not guaranteed.
</td>
</tr>
<tr>
<td>
astropy.nddata
</td>
<td align='center'>
<span class="dev"></span>
</td>
<td>
Significantly revised in v1.0 to implement <a href="https://github.com/astropy/astropy-APEs/blob/master/APE7.rst">APE 7</a>. Major changes in the API are not anticipated, broader use may reveal flaws that require API changes.
</td>
</tr>
<tr>
<td>
astropy.samp
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
Virtual Observatory service access: SAMP. This was renamed from astropy.vo.samp to astropy.samp in 2.0.
</td>
</tr>
<tr>
<td>
astropy.stats
</td>
<td align='center'>
<span class="dev"></span>
</td>
<td>
Likely to maintain backwards-compatibility, but functionality continually being expanded, so significant additions likely in the future.
</td>
</tr>
<tr>
<td>
astropy.table
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
Incremental improvements since v0.1, mostly stable API with backwards compatibility an explicit goal.
</td>
</tr>
<tr>
<td>
astropy.time
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
Incremental improvements since v0.1, API likely to remain stable
for the foreseeable future.
</td>
</tr>
<tr>
<td>
astropy.units
</td>
<td align='center'>
<span class="mature"></span>
</td>
<td>
Incremental improvements since v0.4. Functionality mature and unlikely to change. Efforts focused on performance and increased interoperability with Numpy functions.
</td>
</tr>
<tr>
<td>
astropy.utils
</td>
<td align='center'>
<span class="dev"></span>
</td>
<td>
Contains mostly utilities destined for internal use with other parts of Astropy. Existing functionality generally stable, but regular additions and occasional changes.
</td>
</tr>
<tr>
<td>
astropy.uncertainty
</td>
<td align='center'>
<span class="dev"></span>
</td>
<td>
New in v3.1, in heavy development.
</td>
</tr>
<tr>
<td>
astropy.visualization
</td>
<td align='center'>
<span class="dev"></span>
</td>
<td>
New in v1.0, and in development.
</td>
</tr>
<tr>
<td>
astropy.visualization.wcsaxes
</td>
<td align='center'>
<span class="stable"></span>
</td>
<td>
New in v1.3. Originally developed as <tt class="docutils literal"><span class="pre">wcsaxes</span></tt> and has maintained a stable API.
</td>
</tr>
<tr>
<td>
astropy.wcs
</td>
<td align='center'>
<span class="stable"></span>
</td>
<td>
Originally developed as <tt class="docutils literal"><span class="pre">pywcs</span></tt>, and has a stable API for now. However, there are plans to generalize the WCS interface to accommodate non-FITS WCS transformations, and this may lead to small changes in the user interface.
</td>
</tr>
</table>
|
