# Getting Started¶

## Installation¶

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 idaes-support@idaes.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.

Note

IDAES supports Python 3.6 and above.

System Section
Linux Linux
Windows Windows
Mac OSX Mac/OSX
Generic Generic install

Warning

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.

## Windows¶

Install Miniconda (optional)

3. Open the Anaconda Prompt (Start -> “Anaconda Prompt”).
4. In the Anaconda Prompt, follow the Generic install instructions.

## Linux¶

Install Miniconda (optional)

2. Open a terminal window

Install Dependencies

1. The IPOPT solver depends on the GNU FORTRAN, GOMP, Blas, and Lapack libraries, If these libraries are not already installed on your Linux system, you or your system administrator can use the sample commands below to install them. If you have a Linux distribution that is not listed, IPOPT should still work, but you the commands to install the required libraries may differ. If these libraries are already installed, you can skip this and proceed with the next step.

Note

Depending on your distribution, you may need to prepend sudo to these commands or switch to the “root” user.

apt-get (Current Ubuntu based distributions):

sudo apt-get install libgfortran4 libgomp1 liblapack3 libblas3


yum (Current RedHat based distributions, including CentOS):

yum install lapack blas libgfortran libgomp


Complete Generic Install

## Mac/OSX¶

Install Miniconda (optional)

2. For the next steps, open a terminal window

Complete Generic Install

## Generic install¶

The remaining steps performed in either the Linux or OSX Terminal or Powershell. If you installed Miniconda on Windows use the Anaconda Prompt or Anaconda Powershell Prompt. Regardless of OS and shell, the following steps are the same.

Install IDAES

1. Install IDAES with pip:

pip install idaes-pse

2. Run the idaes get-extensions command to install the compiled binaries:

idaes get-extensions


Warning

The IDAES binary extensions are not yet supported on Mac/OSX.

As fallback (assuming you are uisng a conda env) you can install the generic ipopt solver with the command conda install -c conda-forge ipopt though this will not have all the features of our extentions package.

Note

If you are installing on Linux, you can specify a specific platform. While most Linux builds are interchangeable, specifying a build can make managing dependencies considerably easier. By default Linux will use the CentOS 7 build. To specify a build use the command idaes get-extensions --platform <platform>. Supported Linux platforms are: rhel6, rhel7, rhel8, cetos6, centos7, centos8, ubuntu1804, ubuntu1910, and ubuntu2004. If you are not using a supported platform, everything should still work, just choose the platform that best matches your Linux distribution. You can also use the idaes get-extensions-platforms command to see a list of supported platforms.

1. Run the idaes get-examples command to download and install the example files:

idaes get-examples


By default this will install in a folder “examples” in the current directory. The command has many options, but an important one is –dir, which specifies the folder in which to install.

for Mac and Linux users this would look like:

idaes get-examples --dir ~/idaes/examples


or, for Windows users, it would look like:

idaes get-examples --dir C:\Users\MyName\IDAES\Examples


pytest --pyargs idaes -W ignore