Getting Started¶

Note

IDAES supports Python 3.8 to 3.11. Newer versions of Python may work, but are untested.

Installation¶

To install the IDAES PSE framework, follow the set of instructions below that are appropriate for your needs. The OS specific instructions provide optional steps for installing Miniconda, which can be skipped. If you are an IDAES developer or expect to change IDAES code, we recommend following the advanced user installation. Please contact idaes-support@idaes.org, if you have difficulty installing IDAES.

After installing and testing IDAES, it is recommended that you do IDAES tutorials located on the examples online documentation page.

OS Specific Instructions¶

System	Section
Linux	Linux Installation Guide
Windows	Windows Installation Guide
Mac OSX	Mac Installation

Warning

If you are using Python for other projects or installing multiple versions of IDAES, you may want to consider using environments to avoid conflicting dependencies. There are several good options including conda environments or venv.

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.

Warning

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:
```
idaes --version
```
Install the upgraded version of the idaes-pse package using pip install:
```
pip install --upgrade idaes-pse
```

If a newer version of the idaes-pse package 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

Run the idaes get-extension command to install compiled binaries compatible with the newly upgraded IDAES version. The --extra petsc argument installs the optional PETSc solver. These binaries include solvers and function libraries. See Binary Packages for more details.:
```
idaes get-extensions --extra petsc
```
Finally, use the idaes get-examples command to install the most recent version of the IDAES examples compatible with the upgraded IDAES version.

Warning

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