https://github.com/ornl/gridkit
Experimental code for prototyping interfaces betwen numerical libraries and network models.
https://github.com/ornl/gridkit
Last synced: about 2 months ago
JSON representation
Experimental code for prototyping interfaces betwen numerical libraries and network models.
- Host: GitHub
- URL: https://github.com/ornl/gridkit
- Owner: ORNL
- License: other
- Created: 2023-07-18T21:04:27.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-08T15:25:54.000Z (2 months ago)
- Last Synced: 2025-04-08T16:28:43.912Z (2 months ago)
- Language: C++
- Size: 1.56 MB
- Stars: 8
- Watchers: 7
- Forks: 4
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GridKit™
This is experimental code for prototyping interfaces for dynamic
simulations, sensitivity analysis and optimization. Target applications
are power grids, but the methodology and the framework could be used
in other areas without major modifications.
## 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.0.0
- [Suitesparse](https://github.com/DrTimothyAldenDavis/SuiteSparse) >= 5.x (optional)
- If using Suitesparse, SUNDIALS must also be built with [KLU support](https://sundials.readthedocs.io/en/latest/sundials/Install_link.html#cmakeoption-ENABLE_KLU)
- [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.12
- C++ 17 compliant compiler
### 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 ([email protected]) and has received contributions
from Tamara Becejac (Avangrid), R. Cameron Rutherford (PNNL), Asher J. Mancinelli (NVIDIA), and Reid Gomillion (Virginia Tech).