Skip to content

ORNL/GridKit

Repository files navigation

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
  • CMake >= 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

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:

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 contribution from Abdourahman Barry (Virginia Tech), Tamara Becejac (Avangrid), Adam Birchfield (Texas A&M), Reid Gomillion (Virginia Tech), Nicholson Koukpaizan (ORNL), Asher J. Mancinelli (NVIDIA), Alex Novotny (Virginia Tech), Shaked Regev (ORNL), and R. Cameron Rutherford (PNNL).