Skip to content
The IDAES Process Systems Engineering Framework
Python JavaScript Jupyter Notebook C++ C HTML Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci idaes-dev as of fbe8f82 Jun 13, 2019
.github 1.0 release candidate Feb 1, 2019
apps/ddm-learning idaes-dev as of 4964d34 Aug 9, 2019
docs
examples/workshops idaes-dev as of 4964d34 Aug 9, 2019
idaes
scripts
ui/modelvis idaes-dev as of 03c1980 Jul 2, 2019
.coveragerc Bringing in idaes-dev as of 9466a2a Mar 22, 2019
.coveralls.yml Bringing in work from dev Feb 26, 2019
.gitignore Doc changes for patch release 1.0.1 Feb 6, 2019
COPYRIGHT.md idaes-dev as of e27d5d0 May 31, 2019
Dockerfile idaes-dev as of 2fd50de Jun 26, 2019
LICENSE.md
Makefile idaes-dev as of 4964d34 Aug 9, 2019
Makefile.in 1.0 release candidate Feb 1, 2019
README.md idaes-dev as of fbe8f82 Jun 13, 2019
codecov.yml
conftest.py Bringing in idaes-dev as of 9466a2a Mar 22, 2019
idaes-docker idaes-dev as of 4f4da29 and 1.1-rc1 May 14, 2019
install-solvers.sh Bringing in idaes-dev as of 9466a2a Mar 22, 2019
pytest-dev.ini
pytest.ini
requirements-dev.txt
requirements.txt idaes-dev as of 4964d34 Aug 9, 2019
setup.cfg
setup.py

README.md

CircleCI Coverage Status

IDAES Toolkit

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.

System requirements

The code and examples have been tested with the following operating systems:

Operating system Supported versions
Linux Any modern Linux
Windows Windows 10
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.

Contributing

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.

Getting Started

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 all

To view the documentation you just built, open the file docs/build/index.html in a web browser.

Running tests

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, unit models and DMF, and generate a coverage report, run tests in idaes/ with the following command:

$ pytest  # Please note some tests may be skipped based on solver availability. 

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 access them, you should start up a notebook server using the following command.

jupyter notebook

This should start up a notebook server and then pop up a tab or window in your default web browser showing the available notebooks. 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. For more details on the examples, please refer to the online documentation.

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

You can’t perform that action at this time.