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. For help or to discuss specific sub-packages, refer to the maintainer list to find who to contact.

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.coordinates		Any future changes should largely maintain backwards compatibility.
sunpy.data		Should see no major changes.
sunpy.database		While it has not changed recently, it could be subject to major revisions in future.
sunpy.image		While it has not changed recently, it could be subject to major revisions in future.
sunpy.instr		Will be removed in sunpy 3.1. Please use `sunkit_instruments`.
sunpy.io		Should see no major changes.
sunpy.map		Any future changes should largely maintain backwards compatibility.
sunpy.net		Any future changes should largely maintain backwards compatibility.
sunpy.physics		While it has not changed recently, it could be subject to major revisions in future.
sunpy.roi		Will be removed in sunpy 3.1. There is little functionality.
sunpy.sun		Sub-module `constants` is stable. Sub-module `models` will likely have major changes.
sunpy.time		Any future changes should largely maintain backwards compatibility.
sunpy.timeseries		Any future changes should largely maintain backwards compatibility.
sunpy.util		This sub-module is not user facing and can and will change between versions.
sunpy.visualization		Any future changes should largely maintain backwards compatibility.

Taken with love from the Astropy project.