Skip to content

Commit

Permalink
Merge pull request #9 from PaulTalbot-INL/readme_update
Browse files Browse the repository at this point in the history
added individual tools to README
  • Loading branch information
dylanjm authored Apr 22, 2024
2 parents 37b8c88 + 09c6239 commit 1f705e0
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,28 @@

![FORCE](assets/FORCE_logo-color.png)

The Framework for Optimization of ResourCes and Economics is a collection of software tools, models, and datasets acquired and developed under the Integrated Energy Systems (IES) program to enable analysis of technical and economic viability of myriad IES configurations. FORCE is the consolidating interface and data repository for all the IES toolsets ranging from macro technoeconomic analysis to transient process modeling and experimental validation for integrated energy systems.

# FORCE Use Cases
# Tools
The FORCE framework makes use of several distinct tools to enable technical and economic system analysis of integrated energy systems. The three main tools are:

![HYBRID](https://github.com/idaholab/HYBRID/blob/devel/doc/logos/HYBRID_Logo_color.png)

- [HYBRID](https://github.com/idaholab/HYBRID), which includes technical models of energy systems,

![ORCA](https://github.com/idaholab/ORCA/blob/main/docs/logo/ORCA_transparent.png)

- [ORCA](https://github.com/idaholab/ORCA), which provides tools for the real-time optimization of integrated system control, and

![HERON](https://github.com/idaholab/HERON/blob/devel/logos/HERON_logo_full.png)

- [HERON](https://github.com/idaholab/HERON), for long-term system cost, portfolio sizing, and dispatch optimization.

While FORCE is a framework that connects these tools, currently each tool can be used independently for different parts of the integrated energy systems technical and economic analysis.

## FORCE Use Cases

In addition to the tools available as part of FORCE, several existing use cases that demonstrate use of FORCE are included by way of example in this code base. These are listed in brief below:

| SHORT NAME | DESCRIPTION | REPORT |
|:-----------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------:|
Expand All @@ -15,5 +34,5 @@



# Notes
## Testing
The FORCE repo should contain several IES tools. For the FORCE tests in "FORCE/tests/integrations_tests" to work, raven, TEAL, and HERON should be under FORCE. The FORCE tests depend on raven libraries which can be activated as follows: "conda activate raven_libraries"

0 comments on commit 1f705e0

Please sign in to comment.