Current status of sub-packages

SunPy has in variations in stability across sub-packages. This document summarizes the current status of the SunPy 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:

Planned
Actively developed, be prepared for possible significant changes.
Reasonably stable, any significant changes/additions will generally include backwards-compatiblity.
Mature. Additions/improvements possible, but no major changes planned.
Pending deprecation. Might be deprecated in a future version.
Deprecated. Might be removed in a future version.

The current planned and existing sub-packages are:

Sub-Package   Comments
sunpy.lightcurve Deprecated in 0.8, will be removed in 1.0.
sunpy.coordinates Should be stable, but more features are being added that might require backwards incompatible changes.
sunpy.roi There is very little functionality.
sunpy.sun Certainly in for a large refactor pre-1.0.
sunpy.net We intend to maintain backwards compatibility post 0.9.
sunpy.image None
sunpy.timeseries No plans to change what we currently have but only add to it.
sunpy.cm Should see minor change in 1.0.
sunpy.instr None
sunpy.wcs Deprecated in 0.8, will be removed in 1.0.
sunpy.spectra Deprecated in 0.8, will be removed in 1.0.
sunpy.visualization No plans to change what we currently have but only add to it.
sunpy.physics None
sunpy.database Undergoing activate changes with each major release.
sunpy.io Should see no changes in 1.0 release.
sunpy.time Will see major changes in 1.0.
sunpy.map Stable in 0.9, mature in 1.0.
sunpy.data Should see no change in 1.0.

Taken with love from the Astropy project.