Getting Started#

Note

IDAES supports Python 3.8 to 3.12. 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 website.

OS Specific Instructions#

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.

Installing optional dependencies#

To keep the base installation lighter and more flexible, some of the IDAES components are not installed by default, but can be installed as optional dependencies. For more information, refer to the Installing optional dependencies page.

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.

  1. Open a terminal and verify the currently installed version of IDAES:

    idaes --version
    
  2. 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
  1. 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
    
  2. Install the IDAES example Jupyter notebooks.

To run the examples on your own computer, follow the instructions on the idaes-examples page on PyPI.