Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 1.34 KB

version.rst

File metadata and controls

54 lines (40 loc) · 1.34 KB
Raw

IDAES Versioning

The IDAES Python package is versioned according to the general guidelines of semantic versioning, following the recommendations of PEP 440 with respect to extended versioning descriptors (alpha, beta, release candidate, etc.).

Basic usage

You can see the version of the package at any time interactively by printing out the __version__ variable in the top-level package:

import idaes
print(idaes.__version__)
# prints a version like "1.2.3"

# This test ensures that the above code works without needing to be # updated every time the IDAES version changes import idaes idaes.__version__

Advanced usage

This section describes the module's variables and classes.

Overview

idaes.ver

Version class

The versioning semantics are encapsulated in a class called Version.

idaes.ver.Version

HasVersion class

For adding versions to other classes in a simple and standard way, you can use the HasVersion mixin class.

idaes.ver.HasVersion