Package: idaes-pse
IDAES ToolkitThe 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 StatusesGetting StartedOurcomplete documentation is onlinebut here is a summarized set of steps to get started using the framework.While not required, we encourage the installation ofAnacondaorMinicondaand using thecondacommand 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:condacreate--nameidaes-psepython=3.10
condaactivateidaes-pseNow, in that "idaes-pse" environment, install the IDAES Toolkit using eitherpip installorconda install(but not both):# install latest stable releasepipinstallidaes-pse# install latest stable release with one set of optional dependencies, e.g. `ui` for the user interfacepipinstall"idaes-pse[ui]"# install latest stable release with multiple sets of optional dependenciespipinstall"idaes-pse[ui,dmf,omlt,grid,coolprop]"# install latest version from the main branch of this repositorypipinstall"idaes-pse @ git+https://github.com/IDAES/idaes-pse@main"# install from the `mybranch` branch of the fork belonging to `myuser`pipinstall"idaes-pse @ git+https://github.com/myuser/idaes-pse@mybranch"You can check the version installed with the command:idaes--versionNow install the pre-built extensions (binary solvers):idaesget-extensionsThe IDAES examples can be installed by running:pipinstallidaes-examplesFor more information, refer to theIDAES/examplesrepository, as well as the online static version of the examples available athttps://idaes-examples.readthedocs.org.Finally, refer to thecomplete idaes-pse documentationfor detailedinstallation instructions, examples, guides, and reference.System requirementsThe code and examples have been tested with the following operating systems:Operating systemSupported versionsLinuxAny modern LinuxWindowsWindows 10macOSPartly 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.8Python 3.9Python 3.10Python 3.11Note that Python 3.6 isnotsupported.Contacts and more informationGeneral, background and overview information is available at theIDAES main website.
Framework development happens at ourGitHub repowhere you can ask questions by starting adiscussion,report issues/bugsormake contributions.
For further enquiries, send an email to:idaes-support@idaes.orgFunding acknowledgementsThis work was conducted as part of theInstitute for the Design of Advanced Energy Systems (IDAES)with support through theSimulation-Based Engineering, Crosscutting Research Programwithin the U.S. Department of Energy’sOffice of Fossil Energy and Carbon Management (FECM).
As of 2021, additional support was provided by FECM’sSolid Oxide Fuel Cell Program,
andTransformative Power Generation Program.ContributingPlease see ourAdvanced User InstallationandHow-to Guideson 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.