ExaGO
High-performance power grid optimization for stochastic, security-constrained, and multi-period ACOPF problems.
https://github.com/pnnl/exago
Category: Energy Systems
Sub Category: Grid Analysis and Planning
Keywords from Contributors
acopf bfgs constrained-optimization gpu-support interior-point-method interior-point-optimizer math-physics mpi nonlinear-optimization nonlinear-programming
Last synced: about 3 hours ago
JSON representation
Repository metadata
High-performance power grid optimization for stochastic, security-constrained, and multi-period ACOPF problems.
- Host: GitHub
- URL: https://github.com/pnnl/exago
- Owner: pnnl
- License: other
- Created: 2023-08-02T21:05:34.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2025-01-30T20:24:00.000Z (3 months ago)
- Last Synced: 2025-04-01T22:25:49.606Z (27 days ago)
- Language: C++
- Homepage:
- Size: 127 MB
- Stars: 79
- Watchers: 11
- Forks: 12
- Open Issues: 57
- Releases: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Support: SUPPORT.md
README.md
ExaGOTM is a package for solving large-scale power grid optimization problems on parallel and distributed architectures, particularly targeted for exascale machines with heteregenous architectures (GPU). Combinations of stochastic, contingency-constrained, multiperiod ACOPF problems can be solved with ExaGO. The package is written in C/C++ with python bindings available for python-based applications. An overview of the package is given on this page. For extended information, including the modeling details and formulations, see the ExaGO manual.
ExaGOTM includes the following applications for solving different power grid optimization problems:
- OPFLOW solves an AC optimal power flow either on CPU and GPU
- TCOPFLOW solves a multi-period optimal power flow
- SCOPFLOW solves a security-constrained (contingency-constrained) optimal power. Both single-period and multi-period problems can be solved.
- SOPFLOW solves a stochastic optimal power flow with (optional) security constraints for single and multiple periods.
ExaGOTM applications are interfaced with the following optimization solver packaages:
- Ipopt is a popular optimization package for solving nonlinear optimization problems that uses an interior-point algorithm.
- HiOp is a HPC package for optimization. ExaGO interfaces with two of its solvers -- a mixed sparse-dense interior-point solver (NewtonMDS) and a sparse interior-point solver (HiOPSparse). NewtonMDS allows execution of the optimization either on CPU and GPU. The sparse HiOp solver is currently supported on CPU only.
Note that not all applications can utilize all solvers yet. The following table lists the solver-application compatibility.
Solver | OPFLOW | TCOPFLOW | SCOPLOW | SOPFLOW |
---|---|---|---|---|
Ipopt | Y | Y | Y | Y |
HiOp | Y | Y | Y |
Additionally, note that SCOPFLOW and SOPFLOW with HiOp solver use Ipopt to solve a portion of the problem (base problem). So one must also configure with Ipopt when using HiOp solver for these applications.
Installing
Details installation instructions are given at INSTALL.md for information on acquiring, building and installing ExaGO.
If you are a developer with access to the project, we also provide public binaries that are generated through our GitHub actions workflows documented in README.md, and with documentation about usage in the packages section of our repository. Check out a short (< 60s demo) of pulling down a version of ExaGO:
Developer Guide
You can view the following helpful documentation sources:
- test_add.md markdown file for information on adding tets (outdated)
- README.md for our bash / spack buildsystem used in GitHub/GitLab CI/CD
- README.md for our spack specific build scripts that support CI tcl modules on HPC target platforms
- README.md for our devcontianer configuration information (codespace support coming soon)
- exago_policy_compatiblility for xSDK compatibility guidelines, and ways to enforce compliance
- python_bindings.md for documentation about or Python bindings
- README.md for information about profiling ExaGO with spack
- README.md for details about our GitHub actions
- README.ci_clusters.md for CI cluster workflow documentation
- README.summit.md for ORNL's Summit specific configuration
Vizualisation
Our ChatGrid frontend deployed with React, PSQL and LangChain has documentation in README.md as well as a pdf README.pdf in the viz
subdirectory. Several of our tutorials install this through commands in Jupyter Notebooks as well.
Usage
Instructions for executing the different ExaGOTM applications is given below.
We also provide our user manual as a pdf manual.pdf -> need to update this regularly with CI / move to quarto docs.
Tutorials
- If you are using a devcontainer with VSCode, the following tutorials are provided:
- tutorial.ipynb for basic configuration infromation and I/O
- mpi4py-tutorial.ipynb for mpi4py pointers and best practices
- viz-tutorial.ipynb for spinning up our frontend visualization with ChatGrid integration
- Otherwise, you can check out our more in depth application tutorials in the
tutorials
subdirectory:- demo1.ipynb run OPFLOW, SCOPFLOW and visualize your output
- demo2.ipynb run SOPFLOW on many ranks using MPI, and visualize outpu
- TODO - add fixes from
mpi4py
devcontainer example into this notebook to show working MPI workflow
- TODO - add fixes from
Options
Each application has a different set of options that are described in depth in the usage notes. These options can be passed optionally through an options file (-optionsfile <option_file>
), or directly on the command line.
Since options may be specified in more than one location (on the command line, and through an options file), it is worth noting that the option specified on the command line supersede those in the options file. For example, if opflowoptions
options file set the network file via the option -netfile case9mod.m
, the following behavior occurs:
# This uses case9mod.m
./opflow -optionsfile opflowoptions
# This uses case118.m
./opflow -netfile case118.m -options_file opflowoptions
Visualization (experimental)
ExaGO has an experimental visualization to display the results of OPFLOW
application on a map. See the visualization README for more information.
Contributing
Please see the developer guidelines before attempting to contribute.
Feel free to raise an issue or contact the team if the guidelines are ambiguous or you have a particular question.
Authors
- Shrirang Abhyankar
- Slaven Peles
- Asher Mancinelli
- Cameron Rutherford
- Bruce Palmer
- Jaelyn Litzinger
- William Perkins
- Sayef Azad Sakin
- Joseph Macam
- Ryan Danehy
- Nicholson Koukpaizan
Acknowledgement
This package is developed as a part of ExaSGD project under the Exascale computing project.
Copyright
Copyright © 2020, Battelle Memorial Institute.
ExaGOTM is a free software distributed under a BSD 2-clause license. You may reuse, modify, and redistribute the software. See the license file for details.
Disclaimer
This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.
Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.
Owner metadata
- Name: Pacific Northwest National Laboratory (Public)
- Login: pnnl
- Email: [email protected]
- Kind: organization
- Description: This Org is intended for the hosting of approved released PNNL software repositories for public use and collaboration.
- Website: http://www.pnnl.gov/
- Location: United States of America
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/10872965?v=4
- Repositories: 351
- Last ynced at: 2024-10-29T10:16:17.647Z
- Profile URL: https://github.com/pnnl
GitHub Events
Total
- Issues event: 3
- Watch event: 13
- Delete event: 1
- Issue comment event: 22
- Push event: 22
- Pull request review event: 5
- Pull request event: 9
- Fork event: 3
- Create event: 4
Last Year
- Issues event: 3
- Watch event: 13
- Delete event: 1
- Issue comment event: 22
- Push event: 22
- Pull request review event: 5
- Pull request event: 9
- Fork event: 3
- Create event: 4
Committers metadata
Last synced: 8 days ago
Total Commits: 779
Total Committers: 25
Avg Commits per committer: 31.16
Development Distribution Score (DDS): 0.587
Commits in past year: 22
Committers in past year: 9
Avg Commits per committer in past year: 2.444
Development Distribution Score (DDS) in past year: 0.727
Name | Commits | |
---|---|---|
Shri Abhyankar | s****i@p****v | 322 |
Shrirang | s****r@p****v | 94 |
Mancinelli, Asher J | a****i@p****v | 87 |
Rutherford, Cameron | r****d@p****v | 82 |
Hong Zhang | h****g@m****v | 40 |
Jaelyn Litzinger | j****r@p****v | 32 |
Rylee Sundermann | r****n@s****u | 27 |
Palmer, Bruce J | b****r@p****v | 24 |
Perkins, William A | w****s@p****v | 17 |
Arun Sukumaran Nair | a****r@p****v | 13 |
Peles, Slaven | s****s@p****v | 13 |
Nicholson Koukpaizan | 7****n | 10 |
Amatya, Vinay C | v****a@p****v | 4 |
nedpfeiffer | 1****r | 2 |
Orestis Vasios | 1****s | 2 |
Danehy, Ryan | r****y@p****v | 1 |
Tamara Becejac | t****c@p****v | 1 |
Sakin, Sayef A | s****9@p****v | 1 |
Macam, Joseph D | j****m@p****v | 1 |
Jin, Sichen | s****n@p****v | 1 |
Bruce J Palmer | d****3@c****v | 1 |
Bruce J Palmer | d****3@n****v | 1 |
Jaya Preethi Mohan (JP) | m****5@g****m | 1 |
sichenjin | 5****n | 1 |
pelesh | p****s@o****v | 1 |
Committer domains:
- pnnl.gov: 15
- ornl.gov: 1
- newell03.pnl.gov: 1
- constance-e.pnl.gov: 1
- sdstate.edu: 1
- mcs.anl.gov: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 85
Total pull requests: 83
Average time to close issues: about 2 months
Average time to close pull requests: about 2 months
Total issue authors: 16
Total pull request authors: 13
Average comments per issue: 1.93
Average comments per pull request: 3.13
Merged pull request: 60
Bot issues: 0
Bot pull requests: 0
Past year issues: 12
Past year pull requests: 12
Past year average time to close issues: 28 days
Past year average time to close pull requests: about 1 month
Past year issue authors: 6
Past year pull request authors: 6
Past year average comments per issue: 2.67
Past year average comments per pull request: 2.42
Past year merged pull request: 6
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- cameronrutherford (37)
- jaelynlitz (12)
- nkoukpaizan (6)
- paulrigor (6)
- wperkins (5)
- samachnpl (3)
- nedpfeiffer (3)
- nychiang (3)
- pelesh (3)
- Jayapreethi (1)
- bjpalmer (1)
- SalehSG (1)
- abdelrahman-ayad (1)
- fbonhoff (1)
- ovasios (1)
Top Pull Request Authors
- cameronrutherford (28)
- abhyshr (13)
- jaelynlitz (13)
- nkoukpaizan (9)
- wperkins (5)
- nedpfeiffer (5)
- Jayapreethi (2)
- bjpalmer (2)
- ovasios (2)
- cnpetra (1)
- nychiang (1)
- pelesh (1)
- sichenjin (1)
Top Issue Labels
- bug (9)
- opflow (4)
- sopflow (3)
- xSDK (2)
- enhancement (2)
- question (1)
- documentation (1)
- spack-build (1)
Top Pull Request Labels
- enhancement (5)
- xSDK (4)
- opflow (4)
- bug (2)
- scopflow (1)
- documentation (1)
- manual (1)
- spack-build (1)
- sopflow (1)
Package metadata
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 12
- Total maintainers: 3
spack.io: exago
ExaGO is a package for solving large-scale power grid optimization problems on parallel and distributed architectures, particularly targeted for exascale machines.
- Homepage: https://github.com/pnnl/ExaGO
- Licenses: []
- Latest release: 1.4.1 (published about 3 years ago)
- Last Synced: 2025-04-27T15:04:26.717Z (1 day ago)
- Versions: 12
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Average: 28.637%
- Dependent packages count: 57.274%
- Maintainers (3)
Dependencies
- actions/checkout v3 composite
- shogo82148/actions-setup-perl v1 composite
- actions/checkout v1 composite
- yesolutions/mirror-action master composite
- actions/checkout v1 composite
- yesolutions/mirror-action master composite
- EndBug/add-and-commit v9.1.3 composite
- actions/checkout v3 composite
- actions/setup-python v3 composite
- pre-commit/action v3.0.0 composite
- actions/checkout v2 composite
Score: 9.230142999272363