Data

Tools

Indexes

Applications

Experiments

Open Source Science

FOQUS

FOQUS: Framework for Optimization and Quantification of Uncertainty and Surrogates

https://github.com/CCSI-Toolset/FOQUS

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    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
    25 of 50 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary

Keywords

foqus idaesplus

Keywords from Contributors

process-systems-engineering process-modeling chemical-engineering mathematical-programming modeling-language nonlinear-programming interactive projection hacking shellcodes
Last synced: 6 months ago · JSON representation

Repository

FOQUS: Framework for Optimization and Quantification of Uncertainty and Surrogates

Basic Info
  • Host: GitHub
  • Owner: CCSI-Toolset
  • License: other
  • Language: Python
  • Default Branch: master
  • Homepage: https://foqus.readthedocs.io
  • Size: 196 MB
Statistics
  • Stars: 47
  • Watchers: 16
  • Forks: 55
  • Open Issues: 26
  • Releases: 52
Topics
foqus idaesplus
Created over 8 years ago · Last pushed 6 months ago
Metadata Files
Readme License

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 <!-- End Status badges -->

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: * Python 3 version of FOQUS * Optional software for FOQUS * Python 2 version of 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. 311342.

Technical Support

If you require assistance, or have questions regarding FOQUS, please send an e-mail to: ccsi-support@acceleratecarboncapture.org or open an issue in GitHub

Owner

  • Name: CCSI Toolset
  • Login: CCSI-Toolset
  • Kind: organization
  • Email: ccsi-support@acceleratecarboncapture.org

The Carbon Capture Simulation Initiative (CCSI) Toolset is a suite of computational models for carbon capture equipment and design processes.

GitHub Events

Total
  • Create event: 11
  • Release event: 10
  • Issues event: 19
  • Watch event: 2
  • Delete event: 3
  • Issue comment event: 39
  • Push event: 18
  • Gollum event: 6
  • Pull request review comment event: 18
  • Pull request review event: 30
  • Pull request event: 15
  • Fork event: 1
Last Year
  • Create event: 11
  • Release event: 10
  • Issues event: 19
  • Watch event: 2
  • Delete event: 3
  • Issue comment event: 39
  • Push event: 18
  • Gollum event: 6
  • Pull request review comment event: 18
  • Pull request review event: 30
  • Pull request event: 15
  • Fork event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 1,389
  • Total Committers: 50
  • Avg Commits per committer: 27.78
  • Development Distribution Score (DDS): 0.828
Past Year
  • Commits: 38
  • Committers: 4
  • Avg Commits per committer: 9.5
  • Development Distribution Score (DDS): 0.605
Top Committers
Name Email Commits
Pedro Sotorrio s****1@l****v 239
Keith Beattie k****e@l****v 131
Joshua Boverhof j****f@l****v 129
anujad95 4****5 127
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 (Top 20 + Academic)
lbl.gov: 7 ad.scilan.pgh: 5 llnl.gov: 4 lanl.gov: 2 netl.doe.gov: 2 joshuas-mbp.lan: 1 crystalcreek.the-lab.llnl.gov: 1 joshuas-mbp-2.lan: 1 joshuas-mbp.lan.dhcp.lbl.gov: 1 nannerl.the-lab.llnl.gov: 1 syncmaster1-pc.the-lab.llnl.gov: 1 178.223.243.131.in-addr.dhcp.lbl.gov: 1 joshuas-macbook-pro.local.dhcp.lbl.gov: 1 80.222.243.131.in-addr.dhcp.lbl.gov: 1 209.221.128.198.in-addr.dhcp.lbnl.us: 1 221.222.243.131.in-addr.dhcp.lbl.gov: 1 76.223.243.131.in-addr.dhcp.lbl.gov: 1 dowlinglab.org: 1 71.223.243.131.in-addr.dhcp.lbl.gov: 1 186.223.243.131.in-addr.dhcp.lbl.gov: 1 128.222.243.131.in-addr.dhcp.lbl.gov: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 653
  • Total pull requests: 635
  • Average time to close issues: 5 months
  • Average time to close pull requests: 14 days
  • Total issue authors: 35
  • Total pull request authors: 26
  • Average comments per issue: 3.51
  • Average comments per pull request: 1.21
  • Merged pull requests: 576
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 12
  • Pull requests: 32
  • Average time to close issues: 5 days
  • Average time to close pull requests: 8 days
  • Issue authors: 6
  • Pull request authors: 4
  • Average comments per issue: 0.08
  • Average comments per pull request: 1.47
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • fsoepyan (130)
  • boverhof (130)
  • ksbeattie (67)
  • sotorrio1 (52)
  • lbianchi-lbl (43)
  • eslickj (42)
  • CSRussell2319 (38)
  • anujad95 (36)
  • bpaul4 (15)
  • jmorgan29 (12)
  • MDCA960418 (9)
  • vchendrix (9)
  • puttak (8)
  • Daison2102 (5)
  • candcook (5)
Pull Request Authors
  • sotorrio1 (112)
  • ksbeattie (99)
  • eslickj (85)
  • lbianchi-lbl (62)
  • anujad95 (58)
  • fsoepyan (54)
  • boverhof (53)
  • bpaul4 (32)
  • franflame (14)
  • ou3llnl (14)
  • kbuma (12)
  • CSRussell2319 (10)
  • mirandamartin (5)
  • candcook (4)
  • pn51 (4)
Top Labels
Issue Labels
Priority:High (164) Priority:Normal (141) bug :bomb: (121) enhancement (102) Documentation (53) SDoE (53) UQ (52) Flowsheet (51) Turbine (35) OUU (33) Testing (32) Examples (29) Priority:Low (27) Optimization (25) Surrogates (20) FOQUS Cloud (19) Installation (17) question (16) FOQUS GUI (16) PSUADE (12) wontfix :disappointed: (10) SimSinter (8) ODoE (5) UX (4) user-submitted (4) backlog (3) ML/AI (2) Pyomo (1) Exploration (1) Optional Software (1)
Pull Request Labels
Priority:High (172) Priority:Normal (156) Documentation (83) SDoE (66) Testing (30) bug :bomb: (27) OUU (25) UQ (23) enhancement (16) FOQUS GUI (15) Flowsheet (11) Priority:Low (10) Installation (8) ODoE (7) ML/AI (6) Examples (6) Optimization (6) FOQUS Cloud (4) PSUADE (4) dependencies (4) Dask (2) SimSinter (1) Surrogates (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 *