python-microgrid documentation

Version: 1.4.1

Maintainer: Avishai Halev

python-microgrid is a Python library to simulate tertiary control of electrical microgrids. It is an extension of TotalEnergies’ [pymgrid](Total-RD/pymgrid). python-microgrid 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 python-microgrid: 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.

python-microgrid 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

• Getting Started
  • Installation
  • Advanced Installation
  • Simple Example
• Examples
  • Quick Start
  • Rule Based Control
  • Model Predictive Control
  • Reinforcement Learning
• API reference
  • Microgrid
  • Modules
  • Module Functions
  • Forecasting
  • Reinforcement Learning (RL) Environments
  • Control Algorithms
  • General functions and objects

Indices and tables

• Index

• Module Index

• Search Page