version¶

Version information for MDTools.

The version information in mdtools.version indicates the release of MDTools. The version number of your installation can be read from mdtools.__version___.

MDTools uses semantic versioning, which is compatible with PEP 440. Given a version number MAJOR.MINOR.PATCH, we increment the

  1. MAJOR version when we make incompatible API changes,

  2. MINOR version when we add functionality in a backwards-compatible manner, and

  3. PATCH version when we make backwards-compatible bug fixes.

Additionally, pre-release, post-release and developmental release specifiers can be appended in accordance to PEP 440. Note that in these cases, PEP 440 differs slightly from the guidlines given in semantic versioning. Namely, PEP 440 states that additional release identifiers are separated from the release version by a dot, whereas semantic versioning requires a hyphen.

Note

As long as the MAJOR number is 0 (i.e. the API has not stabilized), even MINOR increases may introduce incompatible API changes.