pymgrid documentation#

Important Notice#

The person that has been maintaining pymgrid since 2020 has moved future development to python-microgrid for the foreseeable future, a drop in replacement for pymgrid, and pymgrid may not be receiving any future updates. Please open any new issues in python-microgrid. You can also view python-microgrid’s documentation at this link.

Version: 1.2.2

pymgrid is a Python library to simulate tertiary control of electrical microgrids. pymgrid allows users to create and customize microgrids of their choosing. These microgrids can then be controlled using a user-defined algorithm or one of the control algorithms contained in pymgrid: rule-based control and model predictive control.

Environments corresponding to the OpenAI-Gym API are also provided, with both continuous and discrete action space environments available. These environments can be used with your choice of reinforcement learning algorithm to train a control algorithm.

pymgrid attempts to offer the simplest and most intuitive API possible, allowing the user to focus on their particular application.

See the Getting Started section for further information, including instructions on how to install the project.

Useful links: Binary Installers | Source Repository

Note

This project is under active development.

Contents#

Indices and tables#