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.
The code and examples have been tested with the following operating systems:
|Operating system||Supported versions|
|Linux||Any modern Linux|
|Mac OSX||Not supported|
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.7+ (should work, not explicitly tested)
Note that Python 3.5 is not supported.
By contributing to this repository, you are agreeing to all the terms set out in the LICENSE.txt and COPYRIGHT.txt files in this directory.
For installation instructions, please refer to the online documentation.
The documentation for IDAES is built using Sphinx. To generate the HTML version of the documentation, first make sure Sphinx is installed for your version of Python, then go to the "docs/" subdirectory and run the Makefile:
cd docs make html
To view the documentation you just built, open the file
docs/build/index.html in a web browser.
After you install, you can run tests to make sure everything is working. We use pytest for testing and generating code coverage reports. The
pytest command should be available in the conda environment created by running the
install.sh script as described in the installation instructions.
To run tests against the core modules and DMF (not
idaes/contrib), and generate a coverage report:
$ source activate <idaes_conda_env> # If you used "install.sh <idaes_conda_env>" to install $ pytest
To run tests in
idaes/contrib just add that to the pytest command:
$ pytest ideas/contrib # These are not guarenteed to all succeed...
If there are errors, or you are having trouble, you can use our issue tracker on Github to look for other users experiencing similar problems, or to report a new bug.
Running a notebook
There are example Jupyter notebook(s) in the
examples/ directory. To run them, you should invoke Jupyter on a Notebook file (these end in the extension
jupyter notebook examples/run-mea-model.ipynb
This should start up a notebook server and then pop up a tab or window in your default web browser showing the Notebook. For more information on how to use Jupyter, see the "Help" menu in the Notebook window itself, and the extensive documentation on the Jupyter website.
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 report issues/bugs or make contributions. For further enquiries, send an email to: firstname.lastname@example.org