To install the IDAES PSE framework, follow the set of instructions below that are appropriate for your needs and operating system. If you get stuck, please contact firstname.lastname@example.org.
After installing and testing IDAES, it is strongly recommended to do the IDAES tutorials located on the examples online documentation page.
If you expect to develop custom models, we recommend following the advanced user installation.
The OS specific instructions provide information about optionally installing Miniconda. If you already have a Python installation you prefer, you can skip the Miniconda install section.
IDAES supports Python 3.7 and above.
If you are using Python for other complex projects, you may want to consider using environments of some sort to avoid conflicting dependencies. There are several good options including conda environments if you use Anaconda.
Updating an existing installation¶
When a new version is released, an IDAES installation can be updated without having to remove and reinstall it from scratch.
The following steps describe how to upgrade an existing installation in-place, assuming that the installation was done using one of the methods described earlier in this section.
If IDAES was installed in a dedicated environment (e.g. a Conda environment, or Python virtual environment), activate the environment before running any of these commands.
Open a terminal and verify the currently installed version of IDAES:
Install the upgraded version of the
pip install --upgrade idaes-pse
If a newer version of the
idaes-psepackage is available, the currently installed version will be removed and replaced by the newest available version. Check again the IDAES version to verify that the upgrade was successful:idaes --version
idaes get-extensioncommand to install compiled binaries compatible with the newly upgraded IDAES version. These binaries include solvers and function libraries. See Binary Packages for more details.:
Finally, use the
idaes get-examplescommand to install the most recent version of the IDAES examples compatible with the upgraded IDAES version.
If the examples target installation directory is not empty, its contents, including examples installed with a previous IDAES version and other files, will be overwritten without warning. To avoid losing data, it is strongly recommended that you make a backup copy of any existing examples directory before proceeding.
After creating a backup copy of the existing examples directory, run:idaes get-examples