idaes package for idaes module

Set up logging for the idaes module, and import plugins.



idaes.config module

idaes.config.read_config(read_config, write_config)[source]

Read either a TOML formatted config file or a configuration dictionary. :param config: A config file path or dict


idaes.solvers module

idaes.solvers.download_binaries(url=None, verbose=False)[source]

Download IDAES solvers and libraries and put them in the right location. Need to supply either local or url argument.

Parameters:url (str) – a url to download binary files to install files

idaes.ver module

The API in this module is mostly for internal use, e.g. from ‘’ to get the version of the package. But Version has been written to be usable as a general versioning interface.

Example of using the class directly:

>>> from idaes.ver import Version
>>> my_version = Version(1, 2, 3)
>>> print(my_version)
>>> tuple(my_version)
(1, 2, 3)
>>> my_version = Version(1, 2, 3, 'alpha')
>>> print(my_version)
>>> tuple(my_version)
(1, 2, 3, 'alpha')
>>> my_version = Version(1, 2, 3, 'candidate', 1)
>>> print(my_version)
>>> tuple(my_version)
(1, 2, 3, 'candidate', 1)

If you want to add a version to a class, e.g. a model, then simply inherit from HasVersion and initialize it with the same arguments you would give the Version constructor:

>>> from idaes.ver import HasVersion
>>> class MyClass(HasVersion):
...     def __init__(self):
...         super(MyClass, self).__init__(1, 2, 3, 'alpha')
>>> obj = MyClass()
>>> print(obj.version)
class idaes.ver.HasVersion(*args)[source]

Interface for a versioned class.

class idaes.ver.Version(major, minor, micro, releaselevel='final', serial=None, label=None)[source]

This class attempts to be compliant with a subset of PEP 440.

Note: If you actually happen to read the PEP, you will notice that pre- and post- releases, as well as “release epochs”, are not supported.


Get current git hash, with no dependencies on external packages.

idaes.ver.package_version = <idaes.ver.Version object>

Package’s version as an object