Mac/OSX Installation Guide¶
The following commands should be sufficient to get you started with installing and using IDAES. For more information on these steps, see below.
1# Set up & activate Conda new environment with IDAES-PSE 2conda create --yes --name my-idaes-env -c conda-forge -c IDAES-PSE python=3.10 idaes-pse 3conda activate my-idaes-env 4 5# Install IDAES Extensions 6conda install -c conda-forge ipopt 7 8# Install IDAES Examples (optional) 9idaes get-examples 10 11# Run Tests 12pytest --pyargs idaes -W ignore
To get IDAES fully set up on your machine, we’ll go through the steps to get idaes-pse package installed as well as setting up the IDAES extensions, which includes some extra solvers and function libraries, the IDAES example files, and the IDAES tests.
Open a terminal window & run the downloaded script.
We recommend using Conda to manage your environment & modules.
# Create a new Conda environment (Here named my-idaes-env, but this is up to you) conda create --yes --name my-idaes-env python=3.10 conda activate my-idaes-env # Install IDAES Conda package conda install --yes -c IDAES-PSE -c conda-forge idaes-pse
The command above will install the most recent stable (release) version of IDAES. To install other versions of IDAES, including pre-release versions, refer to the Versioned IDAES Installation guide
Install IDAES Extensions¶
If you are not able to successfully run the
command due to network security settings or another reason, you can
download binary release files from
https://github.com/IDAES/idaes-ext/releases, and extract them in the
directory indicated by the
idaes bin-directory command. You will
need both the
appropriate for your operating system.
The IDAES binary extensions are not yet supported on Mac/OSX.
As a fallback (assuming you are using a conda env) you can install
the open source ipopt solver with the command
conda install -c
conda-forge ipopt though this will not have all the features
of our extensions package.
Install IDAES Examples¶
Run the idaes get-examples command to download and install the example files
By default this will install in a folder “examples” in the current directory.
The command has many options, but an important
--dir, which specifies the folder in which to install.
idaes get-examples --dir <PATH>
An example of the path formatting would look like ~/idaes/examples
Run IDAES Tests¶
Run the IDAES test suite to verify that your installation has been successful.
pytest --pyargs idaes -W ignore
You should see the tests run and all should pass to ensure the installation worked. You may see some “Error” level log messages, but they are okay, and produced by tests for error handling. The number of tests that failed and succeeded is reported at the end of the pytest output.