Installation Instructions¶
Contents
The IDAES toolkit is written in Python. It should run under versions of Python 2.7 and 3.6, and above. The toolkit uses [Pyomo](https://www.pyomo.org), a Python-based optimization language. See the Pyomo website for details.
Note
Although Python can run on most operating systems, we are currently only supporting installation of the IDAES PSE framework on Linux. This is due largely to complications of installing third-party solvers, not inherent properties of the PSE framework itself, and we plan to support Windows and Mac OSX installation in the not-too-distant future.
Dependencies¶
Some of the model code depends on external solvers.
Installation on Linux/Unix¶
Install Pyomo¶
Install the master branch of PyUtilib from GitHub using pip:
pip install git+https://github.com/PyUtilib/pyutilib
Install the IDAES branch of Pyomo from GitHub using pip:
pip install git+https://github.com/Pyomo/pyomo@IDAES
Install IDAES¶
The installation is performed by a script at the top level called install.sh. This script will work on UNIX and MacOS systems. There is no Windows script at this time. See below for installation instructions on Windows.
This script uses an advanced, but common, Python packaging system called [Conda](https://conda.io/docs/). Please first consult the [Conda documentation](https://conda.io/docs/user-guide/) to install this on your system. You can use either Anaconda or Miniconda.
Conda allows you to to create separate environments containing files, packages and their dependencies that will not interact with other environments. The install script will automatically create a conda environment, but you need to pick a name for it. Pick a name using only letters, numbers, dashes, or underscores, such as “idaes-python3”. Run the script with this name as the first argument:
` ./install.sh MY_NAME `
- The script will run commands to:
- Create the conda environment
- Build and install the IDAES code into the environment
- Build the HTML documentation
- If the install succeeds, the console will display:
** SUCCESS **
- If the install fails, the console will display:
!! FAILURE !!
IDAES Developer installation¶
The following instructions are for developers and advanced users.
Install the master branch of IDAES from GitHub:
git clone https://github.com/IDAES/idaes.git
Create/switch to your preferred Python environment
Install the requirements with pip install -r requirement.txt
Run python setup.py develop.
Installation on Windows¶
Note
We are NOT supporting Windows at this time. Some developers on the team have had success with the following instructions, but we do not promise that they will work for all users, nor will we prioritize helping debug problems.
Python Distribution¶
Install Anaconda for Windows
Add Anaconda and Anaconda scripts to the path “c:users<user>Anaconda2” and “c:users<user>Anaconda2Scripts”. To do this, search for “Edit system variables” in Windows search. Click on “Edit system environment variables”. Click on “Environment Variables”. Under “System Variables”, search for the variable “Path” and click “Edit”
For Windows 10:
- In the new dialog box, click on “New” and add the path where you find the python.exe file. If you installed Anaconda2, this should be in “c:users<user>Anaconda2”. Copy the address and paste it here.
- Repeat for “c:users<user>Anaconda2Scripts”.
For earlier versions:
- Add path to the existing list, use semicolon as separator
- Type “c:users<user>Anaconda2;c:users<user>Anaconda2Scripts”
Restart the command prompt and type python. If the path variable was added correctly, then you should be able to see the python interpreter as shown below.

Pyomo¶
See instructions for pyomo installation. As mentioned, you can either use the pip or the conda install methods which come included with the Anaconda distribution but conda may be preferable if you installed Anaconda.
To install pyomo using python’s pip package, follow these steps:
Launch the “Anaconda prompt”. You can find this in the start menu under Anaconda.
Navigate to the “Scripts” folder in Anaconda. Or simply type, where pip in the prompt. This should return 1 paths and this should be in the scripts folder.
Pip install pyomo from trunk (we recommend installing the IDAES branch of pyomo)
Install the master branch of PyUtilib from GitHub using pip:
pip.exe install git+https://github.com/PyUtilib/pyutilib
Install the master branch of Pyomo from GitHub using pip:
pip.exe install git+https://github.com/Pyomo/pyomo@IDAES
To install using python’s conda package, follow the following steps:
Launch the “Anaconda prompt”. You can find this in the start menu under Anaconda.
Navigate to the “Scripts” folder in Anaconda. Or simply type, where conda in the prompt. This should return 2 paths and one of these should be in the scripts folder.
In the scripts folder run the following commands:
conda.exe install -c conda-forge pyomo
conda.exe install -c conda-forge pyomo.extras
If the installation was successful, you should see the pyomo executable listed in the Scripts folder. You can check this using the where pyomo command.
IDAES¶
Option 1: Download zip file¶
From the IDAES repository on GitHub, click on “Clone or download” on the right in green. Click on “Download zip”.
Extract the contents in the desired directory you want IDAES in.
Open command prompt and navigate to the folder where you extracted the contents of the IDAES repository (cd <user>/…/<desired directory>/IDAES/).
- Run: python setup.py develop
Option 2: Using Git¶
Install git for Windows.
If cloning the repository from the command line, move to a directory where you want to install the IDAES repository. Then run the following command:
- git clone https://github.com/IDAES/idaes.git
Enter your github user id and password. The git installation in 1 should have added the git executable to your system path and you should be able to execute git commands from the command line.
Open command prompt and navigate to the folder where you extracted the contents of the IDAES repository (cd <user>/…/<desired directory>/IDAES/).
- Run: python setup.py develop