Skip to content

FOQUS: Framework for Optimization and Quantification of Uncertainty and Surrogates

License

Notifications You must be signed in to change notification settings

MAZamarripa/FOQUS-1

 
 

Repository files navigation

Documentation Status AppVeyor Build status

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.

Getting Started

Install

See the installation instructions for details. To see videos on how to install FOQUS, please click here.

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 peformed 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 commmits.

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.

Documentation and User's Manual

The documentation for FOQUS (including the user's manual) can be accessed by clicking here.

Alternately, the html version of the documentation can be generated from following these steps:

  1. Use the Anaconda prompt to go to the "docs" folder in the folder that is generated when FOQUS is downloaded.
  2. For Windows, type "make.bat html". For Linux, type "make html".
  3. The html version of the documentation will be created, and located in the "docs\build\html" folder.

Technical Support

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

About

FOQUS: Framework for Optimization and Quantification of Uncertainty and Surrogates

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 93.3%
  • R 3.9%
  • JavaScript 2.1%
  • GAMS 0.5%
  • Shell 0.1%
  • HTML 0.1%