https://github.com/ornl/gridkit
Modeling framework for power systems simulations and analysis.
https://github.com/ornl/gridkit
Last synced: 10 months ago
JSON representation
Modeling framework for power systems simulations and analysis.
- Host: GitHub
- URL: https://github.com/ornl/gridkit
- Owner: ORNL
- License: other
- Created: 2023-07-18T21:04:27.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2025-08-01T13:57:22.000Z (10 months ago)
- Last Synced: 2025-08-01T14:51:30.066Z (10 months ago)
- Language: C++
- Homepage:
- Size: 2.24 MB
- Stars: 12
- Watchers: 8
- Forks: 5
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GridKit™
The objective of GridKit™ is to provide a modeling framework for power
systems simulations and analysis that can support multiple advanced
analysys methods, such as dynamic constrained optimization and partitioned
numerical integrators for systems of differential and algebraic equations.
While target applications are power grids, the methodology and the
framework could be used in other areas without major modifications.
GridKit™ supports adding multiple families of models to provide different
representations of power grids and possibly other complex engineered systems.
## Installation Guide
GridKit™ has been built and tested on Linux and Mac platforms. It should
be possible to build it on Windows, as well, with Cygwin or native.
Before installing GridKit™ make sure you have all needed dependencies.
### Dependencies
You should have all of the following installed before installing GridKit™
- A version of
- [SUNDIALS](https://github.com/LLNL/sundials) >= 7.4.0 (optional)
- To support sparse linear algebra, SUNDIALS must also be built with [KLU support](https://sundials.readthedocs.io/en/latest/sundials/Install_link.html#cmakeoption-ENABLE_KLU). You most likely want this.
- [Ipopt](https://github.com/coin-or/Ipopt) >= 3.x (optional)
- [Enzyme](https://github.com/EnzymeAD/Enzyme) >=0.0.131 (optional)
- [LLVM](https://github.com/llvm/llvm-project) >= 15.x. GridKit is
currently tested with LLVM 16.
- [CMake](https://cmake.org/) >= 3.13
- C++ 20 compliant compiler
### Cloning and special instructions
```
git clone git@github.com:ORNL/GridKit.git
git submodule update --init third-party/
```
Note, you may need to run the second step periodically as our third party dependencies change.
### Installing
GridKit™ uses CMake for build configuration. Per CMake best practices it is recommended
to build GridKit™ outside the source directory. Building GridKit™ can be as simple as executing
```bash
cmake source_dir
make
make install
```
in the build directory. Dependencies should be autodetected if they are installed in
standard locations, otherwise you need to specify the location of the dependency
manually. For example:
```bash
cmake -DSUNDIALS_DIR=/path/to/sundials/install source_dir
```
You can also use `ccmake` or `cmake-gui` tools to adjust GridKit™ build configuration.
### Testing
Several examples are built together with GridKit™ libraries. These are also used
as functionality test and executed by running `ctest` in the build directory.
## Contributors
GridKit™ is written by Slaven Peles (peless@ornl.gov) and has received
contribution from Abdourahman Barry (Virginia Tech), Tamara Becejac (Avangrid),
Adam Birchfield (Texas A&M), Kaleb Brunhoeber (ORNL), Reid Gomillion (Virginia Tech), Nicholson
Koukpaizan (ORNL), Asher J. Mancinelli (NVIDIA), Alex Novotny (Virginia Tech),
Shaked Regev (ORNL), R. Cameron Rutherford (PNNL), and Wiktoria Zielinska (ORNL).