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:
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:
- Environments
- Permanently Excited DC Motor Environments
- Continuous Current Control DC Permanently Excited Motor Environment
- Continuous Speed Control DC Permanently Excited Motor Environment
- Continuous Torque Control DC Permanently Excited Motor Environment
- Finite Control Set Current Control DC Permanently Excited Motor Environment
- Finite Control Set Speed Control DC Permanently Excited Motor Environment
- Finite Control Set Torque Control DC Permanently Excited Motor Environment
- Externally Excited DC Motor Environments
- Continuous Current Control DC Externally Excited Motor Environment
- Continuous Speed Control DC Externally Excited Motor Environment
- Continuous Torque Control DC Externally Excited Motor Environment
- Finite Control Set Current Control DC Externally Excited Motor Environment
- Finite Control Set Speed Control DC Externally Excited Motor Environment
- Finite Control Set Torque Control DC Externally Excited Motor Environment
- Series DC Motor Environments
- Continuous Current Control Series DC Motor Environment
- Continuous Speed Control Series DC Motor Environment
- Continuous Torque Control Series DC Motor Environment
- Finite Control Set Current Control Series DC Motor Environment
- Finite Control Set Speed Control Series DC Motor Environment
- Finite Control Set Torque Control Series DC Motor Environment
- Shunt DC Motor Environments
- Continuous Current Control Shunt DC Motor Environment
- Continuous Speed Control Shunt DC Motor Environment
- Continuous Torque Control Shunt DC Motor Environment
- Finite Control Set Current Control Shunt DC Motor Environment
- Finite Control Set Speed Control Shunt DC Motor Environment
- Finite Control Set Torque Control Shunt DC Motor Environment
- Permanent Magnet Synchronous Motor Environments
- Current Control Permanent Magnet Synchronous Motor Environment
- Speed Control Permanent Magnet Synchronous Motor Environment
- Torque Control Permanent Magnet Synchronous Motor Environment
- Finite Control Set Current Control Permanent Magnet Synchronous Motor Environment
- Finite Control Set Speed Control Permanent Magnet Synchronous Motor Environment
- Finite Control Set Torque Control Permanent Magnet Synchronous Motor Environment
- Externally Excited Synchronous Motor Environments
- Continuous Control Set Current Control Externally Excited Synchronous Motor Environment
- Continuous Control Set Speed Control Externally Excited Synchronous Motor Environment
- Continuous Control Set Torque Control Externally Excited Synchronous Motor Environment
- Finite Control Set Current Control Externally Excited Synchronous Motor Environment
- Finite Control Set Speed Control Externally Excited Synchronous Motor Environment
- Finite Control Set Torque Control Externally Excited Synchronous Motor Environment
- Synchronous Reluctance Motor Environments
- Abc-Continuous Current Control Synchronous Reluctance Motor Environment
- Abc-Continuous Speed Control Synchronous Reluctance Motor Environment
- Abc-Continuous Torque Control Synchronous Reluctance Motor Environment
- Dq-Continuous Current Control Synchronous Reluctance Motor Environment
- Dq-Continuous Speed Control Synchronous Reluctance Motor Environment
- Dq-Continuous Torque Control Synchronous Reluctance Motor Environment
- Finite Control Set Current Control Synchronous Reluctance Motor Environment
- Finite Control Set Speed Control Synchronous Reluctance Motor Environment
- Finite Control Set Torque Control Synchronous Reluctance Motor Environment
- Squirrel Cage Induction Motor Environments
- Abc-Continuous Current Control Squirrel Cage Induction Motor Environment
- Abc-Continuous Speed Control Squirrel Cage Induction Motor Environment
- Abc-Continuous Torque Control Squirrel Cage Induction Motor Environment
- Dq-Continuous Current Control Squirrel Cage Induction Motor Environment
- Dq-Continuous Speed Control Squirrel Cage Induction Motor Environment
- Dq-Continuous Torque Control Squirrel Cage Induction Motor Environment
- Finite Control Set Current Control Squirrel Cage Induction Motor Environment
- Finite Control Set Speed Control Squirrel Cage Induction Motor Environment
- Finite Control Set Torque Control Squirrel Cage Induction Motor Environment
- Doubly Fed Induction Motor Environments
- Abc-Continuous Current Control Doubly Fed Induction Motor Environment
- Abc-Continuous Speed Control Doubly Fed Induction Motor Environment
- Abc-Continuous Torque Control Doubly Fed Induction Motor Environment
- Dq-Continuous Current Control Doubly Fed Induction Motor Environment
- Dq-Continuous Speed Control Doubly Fed Induction Motor Environment
- Dq-Continuous Torque Control Doubly Fed Induction Motor Environment
- Finite Control Set Current Control Doubly Fed Induction Motor Environment
- Finite Control Set Speed Control Doubly Fed Induction Motor Environment
- Finite Control Set Torque Control Doubly Fed Induction Motor Environment
- Permanently Excited DC Motor Environments
- Reference Generators
- Reward Functions
- Physical Systems
- Supply Converter Motor Load System (SCML)
- Power Electronic Converters
- Mechanical Loads
- Noise Generators
- Electric Motors
- Permanently Excited DC Motor
- Externally Excited DC Motor
- DC Series Motor
- DC Shunt Motor
- Permanent Magnet Synchronous Motor
- Externally Excited Synchronous Motor
- Synchronous Reluctance Motor
- Squirrel Cage Induction Motor
- Doubly Fed Induction Motor
- Base DC Motor
- Base Three Phase Motor
- Base Synchronous Motor
- Base Induction Motor
- Voltage Supplies
- ODE-Solvers
- Supply Converter Motor Load System (SCML)
- Visualization
- Constraint Monitor
- Core
- Utils
- Callbacks
- Random Component