Skip to main content

IDAES Process Systems Engineering Framework

Project description

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.

Project Build and Download Statuses

Tests Integration codecov Documentation Status Services GitHub contributors Merged PRs Issue stats Downloads

Getting Started

Our complete documentation is online but here is a summarized set of steps to get started using the framework. For help and assistance, please visit the IDAES PSE Discussions Board.

While not required, we encourage the installation of Anaconda or Miniconda and using the conda command to create a separate python environment in which to install the IDAES Toolkit.

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.10
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 stable release with one set of optional dependencies, e.g. `ui` for the user interface
pip install "idaes-pse[ui]"
# install latest stable release with multiple sets of optional dependencies
pip install "idaes-pse[ui,omlt,grid,coolprop]"
# install latest version from the main branch of this repository
pip install "idaes-pse @ git+https://github.com/IDAES/idaes-pse@main"
# install from the `mybranch` branch of the fork belonging to `myuser`
pip install "idaes-pse @ git+https://github.com/myuser/idaes-pse@mybranch"

You can check the version installed with the command:

idaes --version

Now install the pre-built extensions (binary solvers):

idaes get-extensions

The IDAES examples can be installed by running:

pip install idaes-examples

For more information, refer to the IDAES/examples repository, as well as the online static version of the examples available at https://idaes-examples.readthedocs.org.

Finally, refer to the complete idaes-pse documentation for detailed installation instructions, examples, guides, and reference.

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
macOS Partly supported*

*HSL is not currently provided for macOS on Intel processors, so some features may be limited or not available.

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.9
  • Python 3.10
  • Python 3.11
  • Python 3.12

[!IMPORTANT] Note that Python 3.8 is no longer officially 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: idaes-support@idaes.org

Funding acknowledgements

This work was conducted as part of the Institute for the Design of Advanced Energy Systems (IDAES) with support through the Simulation-Based Engineering, Crosscutting Research Program within the U.S. Department of Energy’s Office of Fossil Energy and Carbon Management (FECM). As of 2021, additional support was provided by FECM’s Solid Oxide Fuel Cell Program, and Transformative Power Generation Program.

Contributing

Please see our Advanced User Installation and How-to Guides on how to work with the idaes-pse source code and contribute changes to the project.

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.

Project details


Release history Release notifications | RSS feed

This version

2.6.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

idaes-pse-2.6.0.tar.gz (4.5 MB view details)

Uploaded Source

Built Distribution

idaes_pse-2.6.0-py3-none-any.whl (5.3 MB view details)

Uploaded Python 3

File details

Details for the file idaes-pse-2.6.0.tar.gz.

File metadata

  • Download URL: idaes-pse-2.6.0.tar.gz
  • Upload date:
  • Size: 4.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for idaes-pse-2.6.0.tar.gz
Algorithm Hash digest
SHA256 d06f3cffb02cdcb9fe16d76dbf35dbdb71882b10efc583fedcb948f6f03f8ff3
MD5 19d20fb9c2d3a45416fcd3b5cc472440
BLAKE2b-256 d0b45b82bf6bc5ff5113da0a965c78d1ed60c223fede2eeac16cc702a6243ab2

See more details on using hashes here.

File details

Details for the file idaes_pse-2.6.0-py3-none-any.whl.

File metadata

  • Download URL: idaes_pse-2.6.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for idaes_pse-2.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 65a8558ef8ef0a8fa0388176c056711136d9657509253533142fb543bc5aa068
MD5 0d77b1efca6aa5453d2a27e73ce1eed4
BLAKE2b-256 d2297dfb7d1868adec2b335ae6160b67b38a7454634b7d99b99e664a7f6c9963

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page