A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

FOQUS

Framework for Optimization and Quantification of Uncertainty and Surrogates.<!--lint ignore awesome-spell-check-->
https://github.com/CCSI-Toolset/FOQUS

Category: Emissions
Sub Category: Carbon Capture

Keywords

foqus idaesplus

Keywords from Contributors

process-models chemical-engineering process-systems-engineering archiving transforms measur animals compose optimize projection

Last synced: about 23 hours ago
JSON representation

Repository metadata

FOQUS: Framework for Optimization and Quantification of Uncertainty and Surrogates

README.md

FOQUS: Framework for Optimization, Quantification of Uncertainty, and Surrogates

Package includes: FOQUS GUI, Optimization Engine, Turbine Client. Requires access to a Turbine Gateway installation either locally or on a separate cluster/server. #GAMS is required for heat integration option.

Project Status

Documentation Status
Tests
Nightlies
GitHub contributors
Merged PRs
Issue stats
Downloads

Getting Started

Install

To get started right away, start with the installation instructions for the most recent stable release.

We have several videos playlists on how to install FOQUS:

Documentation and User's Manual

Read the full documentation for FOQUS (including the installation manual). Documentation for past releases or the latest (unreleased) development version are available.

A complete set of usage and installation instruction videos for FOQUS are available on our YouTube channel.

FAQ

See our FAQ for frequently asked questions and answers

Authors

See also the list of contributors who participated in this project.

Development Practices

  • Code development will be performed in a forked copy of the repo. Commits will not be
    made directly to the repo. Developers will submit a pull request that is then merged
    by another team member, if another team member is available.
  • Each pull request should contain only related modifications to a feature or bug fix.
  • Sensitive information (secret keys, usernames etc) and configuration data
    (e.g database host port) should not be checked in to the repo.
  • A practice of rebasing with the main repo should be used rather that merge commits.

Versioning

We use SemVer for versioning. For the versions available,
releases or tags on this repository.

License & Copyright

See LICENSE.md file for details.

Reference

If you are using FOQUS for your work, please reference the following paper:

Miller, D.C., Agarwal, D., Bhattacharyya, D., Boverhof, J., Chen, Y., Eslick, J., Leek, J., Ma, J., Mahapatra, P., Ng, B., Sahinidis, N.V., Tong, C., Zitney, S.E., 2017. Innovative computational tools and models for the design, optimization and control of carbon capture processes, in: Papadopoulos, A.I., Seferlis, P. (Eds.), Process Systems and Materials for CO2 Capture: Modelling, Design, Control and Integration. John Wiley & Sons Ltd, Chichester, UK, pp. 311–342.

Technical Support

If you require assistance, or have questions regarding FOQUS, please send an e-mail to: [email protected] or open an issue in GitHub


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 1,382
Total Committers: 50
Avg Commits per committer: 27.64
Development Distribution Score (DDS): 0.829

Commits in past year: 53
Committers in past year: 7
Avg Commits per committer in past year: 7.571
Development Distribution Score (DDS) in past year: 0.566

Name Email Commits
Pedro Sotorrio s****1@l****v 237
Joshua Boverhof j****f@l****v 129
anujad95 4****5 127
Keith Beattie k****e@l****v 126
candcook c****k@l****v 119
eslickj j****k@n****v 118
fsoepyan 3****n 87
Ludovico Bianchi l****i@l****v 63
John Eslick j****k@A****H 61
CSRussell2319 C****l@l****v 58
Joshua Boverhof b****f@j****n 36
Brandon Paul 8****4 23
U-THE-LAB\ou3 o****3@C****v 21
Joshua Boverhof b****f@j****n 15
Makayla Shepherd m****d@l****v 15
John Eslick j****k@a****h 14
Ng, Brenda n****0@l****v 14
Joshua Boverhof b****f@j****v 13
U-THE-LAB\ou3 o****3@N****v 10
Val Hendrix v****x@l****v 9
franflame 8****e 8
ngbrenda 7****a 8
Karlo Berket k****t@l****v 8
ou3 o****3@s****v 6
Anuja Deshpande d****a@A****H 6
Towfiq Ahmed a****q@g****m 5
Joshua Boverhof b****f@1****v 4
Phan N n****7@l****v 4
mirandamartin 5****n 4
Ou o****3@l****v 4
and 20 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 661
Total pull requests: 593
Average time to close issues: 5 months
Average time to close pull requests: 13 days
Total issue authors: 35
Total pull request authors: 26
Average comments per issue: 3.49
Average comments per pull request: 1.16
Merged pull request: 546
Bot issues: 0
Bot pull requests: 2

Past year issues: 18
Past year pull requests: 26
Past year average time to close issues: 20 days
Past year average time to close pull requests: 10 days
Past year issue authors: 7
Past year pull request authors: 7
Past year average comments per issue: 2.28
Past year average comments per pull request: 2.08
Past year merged pull request: 20
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/CCSI-Toolset/FOQUS

Top Issue Authors

  • boverhof (133)
  • fsoepyan (130)
  • ksbeattie (66)
  • sotorrio1 (55)
  • lbianchi-lbl (44)
  • eslickj (42)
  • CSRussell2319 (38)
  • anujad95 (36)
  • bpaul4 (16)
  • jmorgan29 (11)
  • MDCA960418 (9)
  • vchendrix (9)
  • puttak (8)
  • kbuma (6)
  • Daison2102 (5)

Top Pull Request Authors

  • sotorrio1 (99)
  • ksbeattie (90)
  • eslickj (85)
  • anujad95 (59)
  • lbianchi-lbl (58)
  • fsoepyan (54)
  • boverhof (53)
  • bpaul4 (24)
  • ou3llnl (14)
  • CSRussell2319 (10)
  • franflame (10)
  • kbuma (8)
  • mirandamartin (5)
  • candcook (4)
  • pn51 (4)

Top Issue Labels

  • Priority:High (172)
  • Priority:Normal (150)
  • bug :bomb: (121)
  • enhancement (102)
  • SDoE (56)
  • Documentation (54)
  • UQ (53)
  • Flowsheet (51)
  • Turbine (35)
  • OUU (34)
  • Testing (33)
  • Examples (29)
  • Priority:Low (27)
  • Optimization (25)
  • FOQUS Cloud (20)
  • Surrogates (20)
  • Installation (17)
  • FOQUS GUI (17)
  • question (16)
  • PSUADE (12)
  • wontfix :disappointed: (10)
  • SimSinter (8)
  • ODoE (6)
  • UX (4)
  • user-submitted (4)
  • backlog (3)
  • ML/AI (2)
  • Pyomo (1)
  • Exploration (1)
  • Optional Software (1)

Top Pull Request Labels

  • Priority:High (160)
  • Priority:Normal (143)
  • Documentation (76)
  • SDoE (57)
  • Testing (29)
  • bug :bomb: (26)
  • OUU (24)
  • UQ (24)
  • enhancement (14)
  • FOQUS GUI (14)
  • Flowsheet (9)
  • Priority:Low (9)
  • Installation (8)
  • ODoE (7)
  • Examples (7)
  • Optimization (6)
  • ML/AI (5)
  • FOQUS Cloud (4)
  • PSUADE (3)
  • dependencies (3)
  • SimSinter (1)
  • Surrogates (1)
  • Dask (1)

Dependencies

cloud/aws/foqus-websocket-app/onconnect/package.json npm
  • aws-sdk ^2.739.0 development
  • debug >=4.1.1 development
  • debug >=4.1.1
cloud/aws/foqus-websocket-app/ondisconnect/package.json npm
  • aws-sdk ^2.739.0 development
  • debug >=4.1.1 development
  • debug >=4.1.1
cloud/aws/foqus-websocket-app/sendmessage/package.json npm
  • aws-sdk ^2.739.0 development
  • debug >=4.1.1 development
  • debug >=4.1.1
cloud/aws/foqus-websocket-app/status/package.json npm
  • aws-sdk ^2.739.0 development
  • debug >=4.1.1 development
  • debug >=4.1.1
cloud/aws/node/delete-simulation/package.json npm
  • aws-sdk ^2.606.0
  • uuid ^3.2.1
  • uuid-validate
cloud/aws/node/dynamo-stream-trigger/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
  • node-lambda ^0.16.0
  • uuid ^3.2.1
cloud/aws/node/foqus-fake-job-runner/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
  • uuid ^3.2.1
cloud/aws/node/foqus-sns-update/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
  • node-lambda ^0.16.0
  • uuid ^3.2.1
cloud/aws/node/get-session/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
cloud/aws/node/get-session-list/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
cloud/aws/node/get-session-result-page/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
cloud/aws/node/get-simulation-input-file/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
cloud/aws/node/get-simulation-list/package.json npm
  • aws-sdk ^2.606.0
cloud/aws/node/http-basic-authorizer/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
cloud/aws/node/post-session-append/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
  • uuid ^3.2.1
cloud/aws/node/post-session-create/package.json npm
  • uuid ^3.2.1
cloud/aws/node/post-session-kill/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
  • uuid ^3.2.1
cloud/aws/node/post-session-result/package.json npm
  • aws-sdk ^2.606.0
  • collections >=5.1.11
  • debug >=4.1.1
  • uuid ^3.2.1
cloud/aws/node/post-session-start/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
  • uuid ^3.2.1
cloud/aws/node/post-simulation-signed-url/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
cloud/aws/node/put-simulation-input/package.json npm
  • aws-sdk ^2.606.0
  • debug >=4.1.1
cloud/aws/node/put-simulation-name/package.json npm
  • aws-sdk ^2.606.0
.github/workflows/checks.yml actions
  • ./.github/actions/setup-foqus * 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 composite
.github/workflows/nightlies.yml actions
  • conda-incubator/setup-miniconda v2 composite
cloud/aws/node/post-session-stop/package.json npm
  • aws-sdk
  • debug >=4.3.4
  • uuid ^8.3.2
.github/actions/build-docs/action.yml actions
.github/actions/pylint/action.yml actions
.github/actions/setup-foqus/action.yml actions
requirements-dev.txt pypi
  • addheader ==0.3.2 development
  • astroid ==2.11.6 development
  • black ==22.3.0 development
  • coverage * development
  • docutils * development
  • hypothesis * development
  • oyaml * development
  • pre-commit * development
  • pylint ==2.14.1 development
  • pytest * development
  • pytest-cov * development
  • pytest-qt ==4.2. development
  • python-slugify * development
  • singledispatchmethod * development
  • sphinx * development
  • sphinx_rtd_theme * development
requirements.txt pypi
setup.py pypi
  • PyQt5 ==5.15.7
  • TurbineClient *
  • boto3 *
  • cma *
  • joblib <1.3
  • matplotlib <3.6
  • mplcursors *
  • numpy *
  • pandas *
  • psutil *
  • python-tsp ==0.3.1
  • pywin32 <305
  • requests *
  • scipy *
  • tqdm *
  • websocket_client >=1.1.0
  • winshell *

Score: 8.146129510025405