Stability of Subpackages

This document summarizes the stability of PlasmaPy’s subpackages so that users understand where they might expect changes in the future, and which subpackages they can safely use for production code. Please note that backward compatibility is not guaranteed for the 0.*.* series of development releases. Starting with version 1.0.0, the major version number will be incremented when a release contains backward incompatible changes.

The classification is as follows:

Planned
Actively being 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.

PlasmaPy’s planned and existing subpackages are:

Subpackage   Comments
plasmapy.analysis This subpackage is currently under development.
plasmapy.diagnostics This subpackage is currently under development.
plasmapy.dispersion This subpackage is currently under development.
plasmapy.formulary The API of this subpackage is likely to change in future releases.
plasmapy.particles The API of this subpackage is likely to change in future releases.
plasmapy.plasma This subpackage is currently under development.
plasmapy.simulation This subpackage is currently under development.
plasmapy.tests.helpers This subpackage is currently under development.
plasmapy.utils This subpackage is currently under development.