Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
20 of 85 committers (23.5%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (18.0%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
The IDAES Process Systems Engineering Framework
Basic Info
- Host: GitHub
- Owner: IDAES
- License: other
- Language: Python
- Default Branch: main
- Homepage: https://idaes-pse.readthedocs.io/
- Size: 106 MB
Statistics
- Stars: 263
- Watchers: 23
- Forks: 273
- Open Issues: 128
- Releases: 41
Topics
Metadata Files
README.md
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
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 Miniforge with which you can use 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:
bash
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):
```bash
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:
bash
idaes --version
Now install the pre-built extensions (binary solvers):
bash
idaes get-extensions
The IDAES examples can be installed by running:
bash
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.
Owner
- Name: IDAES
- Login: IDAES
- Kind: organization
- Email: idaes-support@idaes.org
- Website: https://idaes.org
- Repositories: 11
- Profile: https://github.com/IDAES
Institute for the Design of Advanced Energy Systems
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- name: "IDAES contributors"
title: "Institute for Design of Advanced Energy Systems (IDAES): advanced computational algorithms to enable the design and optimization of complex, interacting energy and process systems from individual plant components to the entire electrical grid"
url: "https://github.com/IDAES/idaes-pse"
license-url: "https://github.com/IDAES/idaes-pse/blob/main/LICENSE.md"
identifiers:
- description: "OSTI archive of IDAES PSE releases."
type: url
value: "https://www.osti.gov/search/semantic:idaes-pse"
preferred-citation:
type: article
authors:
- family-names: "Lee"
given-names: "Andrew"
- family-names: "Ghouse"
given-names: "Jaffer H"
- family-names: "Eslick"
given-names: "John C"
- family-names: "Laird"
given-names: "Carl D"
- family-names: "Siirola"
given-names: "John D"
- family-names: "Zamarripa"
given-names: "Miguel A"
- family-names: "Gunter"
given-names: "Dan"
- family-names: "Shinn"
given-names: "John H"
- family-names: "Dowling"
given-names: "Alexander W"
- family-names: "Bhattacharyya"
given-names: "Debangsu"
- family-names: "Biegler"
given-names: "Lorenz T"
- family-names: "Burgard"
given-names: "Anthony P"
- family-names: "Miller"
given-names: "David C"
title: "The IDAES process modeling framework and model library—Flexibility for process simulation and optimization"
journal: "Journal of Advanced Manufacturing and Processing"
publisher: "Wiley Online Library"
volume: 3
number: 3
pages: e10095
year: 2021
doi: "doi/10.1002/amp2.10095"
GitHub Events
Total
- Create event: 10
- Release event: 6
- Issues event: 91
- Watch event: 43
- Delete event: 2
- Issue comment event: 297
- Push event: 49
- Gollum event: 2
- Pull request event: 109
- Pull request review event: 325
- Pull request review comment event: 265
- Fork event: 34
Last Year
- Create event: 10
- Release event: 6
- Issues event: 91
- Watch event: 43
- Delete event: 2
- Issue comment event: 297
- Push event: 49
- Gollum event: 2
- Pull request event: 109
- Pull request review event: 325
- Pull request review comment event: 265
- Fork event: 34
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Andrew Lee | a****e@n****v | 1,519 |
| John Eslick | j****k@n****v | 1,205 |
| Dan Gunter | d****r@l****v | 772 |
| jghouse88 | j****e@n****v | 372 |
| Robert | r****r@g****m | 334 |
| Makayla Shepherd | m****d@l****v | 210 |
| Ludovico Bianchi | l****i@l****v | 153 |
| OOAmusat | 4****t | 129 |
| John Eslick | j****k@A****H | 108 |
| Miguel Zamarripa | m****z@n****v | 103 |
| Tim Bartholomew | t****w@n****v | 101 |
| Doug Allan | d****n@k****m | 91 |
| Keith Beattie | K****e@l****v | 91 |
| Perren Yang | p****g@l****v | 71 |
| Xian | x****1@n****u | 67 |
| Xiangyu Yin | x****y@a****u | 63 |
| Jangho Park | J****k@l****v | 60 |
| mengleCMU | m****e@a****u | 57 |
| Bethany Nicholson | b****o@s****v | 49 |
| Abdelrahman Elbashandy | a****y@l****v | 48 |
| Brandon Paul | 8****4 | 43 |
| Jangho Park | j****k@l****v | 42 |
| Emmanuel Ogbe | e****e@p****n | 40 |
| Alex Dowling | a****g@n****u | 30 |
| minhwvu | q****e@m****u | 29 |
| Paul Akula | p****1@g****m | 28 |
| Alejandro Garciadiego | a****d@n****u | 26 |
| agarciadiego | 26 | |
| Chinedu Okoli | c****i@a****h | 25 |
| chineduokoli | c****i@n****v | 24 |
| and 55 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 558
- Total pull requests: 1,105
- Average time to close issues: 5 months
- Average time to close pull requests: 23 days
- Total issue authors: 101
- Total pull request authors: 78
- Average comments per issue: 2.45
- Average comments per pull request: 2.75
- Merged pull requests: 919
- Bot issues: 0
- Bot pull requests: 3
Past Year
- Issues: 67
- Pull requests: 132
- Average time to close issues: about 1 month
- Average time to close pull requests: 15 days
- Issue authors: 22
- Pull request authors: 24
- Average comments per issue: 1.15
- Average comments per pull request: 1.89
- Merged pull requests: 81
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- lbianchi-lbl (87)
- andrewlee94 (65)
- dangunter (64)
- eslickj (57)
- dallan-keylogic (54)
- bpaul4 (16)
- elbashandy (14)
- adam-a-a (13)
- ksbeattie (13)
- TheHuangs (11)
- Robbybp (10)
- adowling2 (9)
- makaylas (8)
- jghouse88 (8)
- TimBartholomew (6)
Pull Request Authors
- andrewlee94 (268)
- eslickj (148)
- lbianchi-lbl (133)
- dallan-keylogic (64)
- dangunter (47)
- bpaul4 (37)
- elbashandy (28)
- blnicho (28)
- Robbybp (25)
- ksbeattie (24)
- OOAmusat (22)
- MAZamarripa (15)
- bknueven (15)
- adowling2 (14)
- AlexNoring (13)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 25,813 last-month
-
Total dependent packages: 7
(may contain duplicates) -
Total dependent repositories: 8
(may contain duplicates) - Total versions: 58
- Total maintainers: 2
pypi.org: idaes-pse
IDAES Process Systems Engineering Framework
- Homepage: https://idaes.org
- Documentation: https://idaes-pse.readthedocs.io/
- License: BSD
-
Latest release: 2.8.0
published 12 months ago
Rankings
Maintainers (2)
proxy.golang.org: github.com/idaes/idaes-pse
- Documentation: https://pkg.go.dev/github.com/idaes/idaes-pse#section-documentation
- License: other
-
Latest release: v1.0.1
published about 7 years ago
Rankings
proxy.golang.org: github.com/IDAES/idaes-pse
- Documentation: https://pkg.go.dev/github.com/IDAES/idaes-pse#section-documentation
- License: other
-
Latest release: v1.0.1
published about 7 years ago
Rankings
Dependencies
- ./.github/actions/display-debug-info * composite
- ./.github/actions/setup-idaes * composite
- actions/checkout v3 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/upload-artifact v2 composite
- codecov/codecov-action v2 composite
- conda-incubator/setup-miniconda v2.1.1 composite
- crate-ci/typos master composite
- ./.github/actions/check-pr-approval * composite
- ./.github/actions/display-debug-info * composite
- ./.github/actions/run-examples * composite
- ./.github/actions/setup-idaes * composite
- actions/checkout v2 composite
- conda-incubator/setup-miniconda v2.1.1 composite
- $BASE_CONTAINER latest build
- ubuntu 18.04 build
- addheader >=0.2.2 development
- alabaster >=0.7.7 development
- astroid ==2.9.3 development
- black >=22.1.0 development
- black ==22.3.0 development
- coverage * development
- flake8 * development
- jsonschema * development
- jupyter_contrib_nbextensions * development
- pre-commit * development
- pylint ==2.12.2 development
- pytest * development
- pytest-cov * development
- snowballstemmer ==1.2.1 development
- sphinx >=3.0.0 development
- sphinx-argparse * development
- sphinx-rtd-theme ==1.0.0 development
- sphinxcontrib-napoleon >=0.5.0 development
- click >=8
- matplotlib *
- networkx *
- numpy *
- pandas *
- pint *
- pyomo >=6.6.2
- scipy *
- see *
- sympy *
- jupyter-cache ==0.6.1 test
- nbmake ==1.5 test