{"id":13721277,"url":"https://github.com/IDAES/idaes-pse","last_synced_at":"2025-05-07T13:32:18.012Z","repository":{"id":37788639,"uuid":"168622088","full_name":"IDAES/idaes-pse","owner":"IDAES","description":"The IDAES Process Systems Engineering Framework","archived":false,"fork":false,"pushed_at":"2024-10-29T19:46:49.000Z","size":110073,"stargazers_count":217,"open_issues_count":101,"forks_count":234,"subscribers_count":25,"default_branch":"main","last_synced_at":"2024-10-29T21:42:35.431Z","etag":null,"topics":["chemical-engineering","process-modeling","process-systems-engineering"],"latest_commit_sha":null,"homepage":"https://idaes-pse.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IDAES.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-01T01:12:51.000Z","updated_at":"2024-10-29T19:46:54.000Z","dependencies_parsed_at":"2024-07-07T12:57:12.664Z","dependency_job_id":"b6d478ed-9bd0-4610-9535-532eae0b28dd","html_url":"https://github.com/IDAES/idaes-pse","commit_stats":{"total_commits":6154,"total_committers":79,"mean_commits":77.89873417721519,"dds":0.7552811179720507,"last_synced_commit":"2ac64179d7b61b353a6e7105c0f166f2bcc742dd"},"previous_names":[],"tags_count":84,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IDAES%2Fidaes-pse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IDAES%2Fidaes-pse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IDAES%2Fidaes-pse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IDAES%2Fidaes-pse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IDAES","download_url":"https://codeload.github.com/IDAES/idaes-pse/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222145687,"owners_count":16938482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chemical-engineering","process-modeling","process-systems-engineering"],"created_at":"2024-08-03T01:01:14.912Z","updated_at":"2025-05-07T13:32:18.006Z","avatar_url":"https://github.com/IDAES.png","language":"Python","funding_links":[],"categories":["Energy Systems"],"sub_categories":["Energy System Modeling Frameworks"],"readme":"# IDAES Toolkit\r\n\r\nThe IDAES Toolkit aims to provide multi-scale, simulation-based, open source\r\ncomputational tools and models to support the design, analysis, optimization,\r\nscale-up, operation and troubleshooting of innovative, advanced energy systems.\r\n\r\n\u003c!-- BEGIN Status badges --\u003e\r\n## Project Build and Download Statuses\r\n[![Tests](https://github.com/IDAES/idaes-pse/actions/workflows/core.yml/badge.svg)](https://github.com/IDAES/idaes-pse/actions/workflows/core.yml)\r\n[![Integration](https://github.com/IDAES/idaes-pse/actions/workflows/integration.yml/badge.svg)](https://github.com/IDAES/idaes-pse/actions/workflows/integration.yml)\r\n[![codecov](https://codecov.io/gh/IDAES/idaes-pse/branch/main/graph/badge.svg?token=1lNQNbSB29)](https://codecov.io/gh/IDAES/idaes-pse)\r\n[![Documentation Status](https://readthedocs.org/projects/idaes-pse/badge/?version=latest)](https://idaes-pse.readthedocs.io/en/latest/?badge=latest)\r\n[![Services](https://github.com/Pyomo/jenkins-status/blob/main/idaes_services.svg)](https://pyomo-jenkins.sandia.gov/)\r\n[![GitHub contributors](https://img.shields.io/github/contributors/IDAES/idaes-pse.svg)](https://github.com/IDAES/idaes-pse/graphs/contributors)\r\n[![Merged PRs](https://img.shields.io/github/issues-pr-closed-raw/IDAES/idaes-pse.svg?label=merged+PRs)](https://github.com/IDAES/idaes-pse/pulls?q=is:pr+is:merged)\r\n[![Issue stats](http://isitmaintained.com/badge/resolution/IDAES/idaes-pse.svg)](http://isitmaintained.com/project/IDAES/idaes-pse)\r\n[![Downloads](https://static.pepy.tech/badge/idaes-pse)](https://pepy.tech/project/idaes-pse)\r\n\u003c!-- END Status badges --\u003e\r\n\r\n## Getting Started\r\n\r\nOur [complete documentation is online](https://idaes-pse.readthedocs.io/en/stable/) 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](https://github.com/IDAES/idaes-pse/discussions).\r\n\r\nWhile not required, we encourage the installation of [Miniforge](https://conda-forge.org/miniforge/) with which you can use the `conda` command to create a separate python environment in which to install the IDAES Toolkit.\r\n\r\nUse conda to create a new \"idaes-pse\" (could be any name you like) environment then activate that environment:\r\n```bash\r\nconda create --name idaes-pse python=3.10\r\nconda activate idaes-pse\r\n```\r\n\r\nNow, in that \"idaes-pse\" environment, install the IDAES Toolkit using either `pip install` or `conda install` (but not both):\r\n\r\n```bash\r\n# install latest stable release\r\npip install idaes-pse\r\n# install latest stable release with one set of optional dependencies, e.g. `ui` for the user interface\r\npip install \"idaes-pse[ui]\"\r\n# install latest stable release with multiple sets of optional dependencies\r\npip install \"idaes-pse[ui,omlt,grid,coolprop]\"\r\n# install latest version from the main branch of this repository\r\npip install \"idaes-pse @ git+https://github.com/IDAES/idaes-pse@main\"\r\n# install from the `mybranch` branch of the fork belonging to `myuser`\r\npip install \"idaes-pse @ git+https://github.com/myuser/idaes-pse@mybranch\"\r\n```\r\n\r\nYou can check the version installed with the command:\r\n\r\n```bash\r\nidaes --version\r\n```\r\n\r\nNow install the pre-built extensions (binary solvers):\r\n\r\n```bash\r\nidaes get-extensions\r\n```\r\n\r\nThe IDAES examples can be installed by running:\r\n\r\n```bash\r\npip install idaes-examples\r\n```\r\n\r\nFor more information, refer to the [IDAES/examples](https://github.com/IDAES/examples) repository, as well as the online static version of the examples available at \u003chttps://idaes-examples.readthedocs.org\u003e.\r\n\r\nFinally, refer to the [complete idaes-pse documentation](https://idaes-pse.readthedocs.io/en/latest) for detailed [installation instructions](https://idaes-pse.readthedocs.io/en/latest/tutorials/getting_started/index.html), examples, guides, and reference.\r\n\r\n## System requirements\r\n\r\nThe code and examples have been tested with the following operating systems:\r\n\r\n|Operating system|Supported versions  |\r\n|----------------|--------------------|\r\n| Linux          | Any modern Linux   |\r\n| Windows        | Windows 10         |\r\n| macOS          | Partly supported*  |\r\n\r\n*HSL is not currently provided for macOS on Intel processors, so some features may be limited or not available.\r\n\r\nMost of the functionality is implemented in Python. In accordance with\r\nthe end-of-life for many Python 2 libraries, the IDAES Toolkit is written\r\nfor Python 3. The following sub-versions are supported:\r\n\r\n* Python 3.9\r\n* Python 3.10\r\n* Python 3.11\r\n* Python 3.12\r\n\r\n\u003e [!IMPORTANT]\r\n\u003e Note that Python 3.8 is no longer officially supported.\r\n\r\n## Contacts and more information\r\n\r\nGeneral, background and overview information is available at the [IDAES main website](https://www.idaes.org).\r\nFramework development happens at our [GitHub repo](https://github.com/IDAES/idaes-pse) where you can ask questions by starting a [discussion](https://github.com/IDAES/idaes-pse/discussions), [report issues/bugs](https://github.com/IDAES/idaes-pse/issues) or [make contributions](https://github.com/IDAES/idaes-pse/pulls).\r\nFor further enquiries, send an email to: \u003cidaes-support@idaes.org\u003e\r\n\r\n## Funding acknowledgements\r\n\r\nThis work was conducted as part of the [Institute for the Design of Advanced Energy Systems (IDAES)](https://idaes.org)\r\nwith support through the [Simulation-Based Engineering, Crosscutting Research Program](https://netl.doe.gov/coal/simulation-based-engineering)\r\nwithin the U.S. Department of Energy’s [Office of Fossil Energy and Carbon Management (FECM)](https://www.energy.gov/fecm/office-fossil-energy-and-carbon-management).\r\nAs of 2021, additional support was provided by FECM’s [Solid Oxide Fuel Cell Program](https://www.energy.gov/fecm/science-innovation/clean-coal-research/solid-oxide-fuel-cells),\r\nand [Transformative Power Generation Program](https://www.energy.gov/fecm/science-innovation/office-clean-coal-and-carbon-management/advanced-energy-systems/transformative).\r\n\r\n## Contributing\r\n\r\nPlease see our [Advanced User Installation](https://idaes-pse.readthedocs.io/en/stable/tutorials/advanced_install/) and [How-to Guides](https://idaes-pse.readthedocs.io/en/stable/how_to_guides/) on how to work with the idaes-pse source code and contribute changes to the project.\r\n\r\n**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.**\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIDAES%2Fidaes-pse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FIDAES%2Fidaes-pse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIDAES%2Fidaes-pse/lists"}