The IDAES Toolkit aims to provide multi-scale, simulation-based, open source computational tools and models to support the design, analysis, optimization, scale-up, operation and troubleshooting of innovative, advanced energy systems.
Our complete documentation is online but here is a summarized set of steps to get started using the framework.
Use conda to create a new "idaes-pse" (could be any name you like) environment then activate that environment:
conda create --name idaes-pse python=3 conda activate idaes-pse
Now, in that "idaes-pse" environment, install the IDAES Toolkit using either
pip install or
conda install (but not both):
# install latest stable release pip install idaes_pse # install latest version from the main branch of this repository pip install 'idaes-pse[prerelease] @ https://github.com/IDAES/idaes-pse/archive/main.zip'
You can check the version installed with the command:
Now install the examples and the pre-build extensions (binary solvers):
idaes get-examples idaes get-extensions # on MacOS use: conda install -c conda-forge ipopt
This will install the examples into an
examples subdirectory which can be opened using a Jypter Notebook:
jupyter notebook examples/notebook_index.ipynb
From there you can explore the examples and tutorials.
For more information on how to use Jupyter Lab, use the built-in Help menu and the extensive documentation on the Jupyter website.
The code and examples have been tested with the following operating systems:
|Operating system||Supported versions|
|Linux||Any modern Linux|
|Mac OSX||Not supported*|
*For advanced users, Mac OSX installation may be performed with some small changes to the Linux installation instructions.
Most of the functionality is implemented in Python. In accordance with the end-of-life for many Python 2 libraries, the IDAES Toolkit is written for Python 3. The following sub-versions are supported:
- Python 3.6
- Python 3.7
- Python 3.8
- Python 3.9+ (should work, not explicitly tested)
Note that Python 3.5 is not supported.
Contacts and more information
General, background and overview information is available at the IDAES main website. Framework development happens at our GitHub repo where you can ask questions by starting a discussion, report issues/bugs or make contributions. For further enquiries, send an email to: firstname.lastname@example.org
By contributing to this repository, you are agreeing to all the terms set out in the LICENSE.md and COPYRIGHT.md files in this directory.