Welcome to gym-electric-motor(GEM)’s documentation!

The gym-electric-motor (GEM) package is a software toolbox for the simulation of different electric motors to train and test reinforcement learning motor controllers and to compare them with classical motor controllers.

Getting started

A quick start guide can be found in the following Readme-File.

Gym Electric Motor Readme:

GEM Content

In the environments section all available GEM-environments are presented with their default configuration. For quick start, one of these can be selected and used out of the box.

The documentation of the base classes is important for the development of own modules like further reward functions or reference generators. In this part, the basic interfaces of each module are specified. For the development of physical models like further motor models or further mechanical load models, the physical system documentation specifies the basic interfaces inside a physical system.

gym-electric-motor Contents:

GEM-Control Content

The GEM-control is a collection of control methods to control the GEM-environments. Currently, classic PI controllers are available for most of the environment types.

GEM-Control Contents:

Indices and tables