Introduction

This documentation contains examples for the IDAES platform.

About IDAES

The Institute for Design of Advanced Energy Systems (IDAES) [Miller et al., 2018] was originated to bring the most advanced modeling and optimization capabilities to the challenges of transforming and decarbonizing the world’s energy systems to make them environmentally sustainable while maintaining high reliability and low cost. For more information please see the IDAES website and the online IDAES documentation.

About this documentation

The examples in this documentation show how to create, configure, and solve IDAES models for a variety of application. Some of the examples are written in a tutorial style with separate “exercise” and “solution” sections to facilitate use in a group setting.

All of the examples are written in Python as Jupyter notebooks. You can browse these notebooks online or download them to and run on your own machine. The online examples have been created with the JupyterBook software package.

Prerequisites

Examples in this documentation are rigorously tested to ensure that they work with the latest version of the IDAES software. For more information on installing IDAES on your platform, please refer to the IDAES documentation.

Getting the source code

The full source code for these examples is available from the IDAES examples repository on GitHub. It may also be installed as a Python package from PyPI with the command:

pip install idaes-examples

Please see the README.md file in the repository for more information.

Getting help

If you find the content of the examples hard to understand, or perhaps incorrect, please reach out to us. Our primary public forum is the idaes-pse discussions page, where you can post questions and also see if others have had a similar problem. You may also contact us directly by sending email to idaes-support@idaes.org.

Bibliography

[MSA+18]

David C. Miller, John D. Siirola, Deb Agarwal, Anthony P. Burgard, Andrew Lee, John C. Eslick, Bethany Nicholson, Carl Laird, Lorenz T. Biegler, Debangsu Bhattacharyya, Nikolaos V. Sahinidis, Ignacio E. Grossmann, Chrysanthos E. Gounaris, and Dan Gunter. Next generation multi-scale process systems engineering framework. In Mario R. Eden, Marianthi G. Ierapetritou, and Gavin P. Towler, editors, 13th International Symposium on Process Systems Engineering (PSE 2018), volume 44 of Computer Aided Chemical Engineering, pages 2209–2214. Elsevier, 2018. URL: https://www.sciencedirect.com/science/article/pii/B9780444642417503633, doi:https://doi.org/10.1016/B978-0-444-64241-7.50363-3.