| ****************************** |
| 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.timeseries |
| </td> |
| <td align='center'> |
| <span class="dev"></span> |
| </td> |
| <td> |
| New in v3.2, in heavy development. |
| </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> |
|
|
