motulator
Motor drive and grid converter simulator in Python
Documentation · Drive examples · Grid examples · Installation
motulator provides simulation models and control algorithms for electric machine drives and grid converter systems. The system models are simulated in the continuous-time domain, while the control algorithms run in discrete time, as they would in a real converter.
Features
- Machine models: induction machines, synchronous reluctance machines, and permanent-magnet synchronous machines, including magnetic saturation and two-mass mechanics
- Grid converter models: L and LCL filters, inductive-resistive grids, and DC-bus dynamics
- Drive control: V/Hz control, current-vector and flux-vector control, sensorless observers, and signal injection
- Grid converter control: grid-following and grid-forming control, including disturbance-observer-based and power-synchronization methods
- Ready-to-run examples as Python scripts and Jupyter notebooks, including neural-network-based flux maps learned from measured data
Installation
pip install motulator
Training the neural-network-based magnetic models of motulator.drive.gradnet additionally needs PyTorch, which is installed with pip install "motulator[gradnet]"; the trained models need only NumPy.
To develop motulator itself, clone the repository as described in the installation guide.
Quick start
A complete simulation takes about 20 lines. This example runs sensorless flux-vector control of a 2.2-kW interior permanent-magnet synchronous machine drive:
import motulator.drive.control.sm as control
from motulator.drive import model, utils
# Continuous-time system model: 2.2-kW IPMSM, mechanics, and converter
par = model.SynchronousMachinePars(n_p=3, R_s=3.6, L_d=0.036, L_q=0.051, psi_f=0.545)
mdl = model.Drive(
model.SynchronousMachine(par),
model.MechanicalSystem(J=0.015),
model.VoltageSourceConverter(u_dc=540),
)
# Discrete-time control system: sensorless flux-vector control
cfg = control.FluxVectorControllerCfg(i_s_max=6.5, sensorless=True)
ctrl = control.VectorControlSystem(
control.FluxVectorController(par, cfg), control.SpeedController(J=0.015, alpha_s=25)
)
# Speed reference and load torque
ctrl.set_speed_ref(lambda t: (t > 0.1) * 50) # rad/s
mdl.mechanics.set_external_load_torque(lambda t: (t > 0.7) * 10) # Nm
res = model.Simulation(mdl, ctrl).simulate(t_stop=1.2)
utils.plot(res)
To go further, start from the drive examples and grid examples. New system models and controllers can be developed using the existing ones as templates.
From simulation to the laboratory
Almost all control methods in the examples have also been implemented and tested on laboratory test benches at Aalto University, such as the one shown here. The simulation models aim to capture the dynamics that matter for control design.
Contributing
If you would like to help us develop motulator, see these guidelines first.
Contributors
Thanks go to these wonderful people:
This project follows the all-contributors specification. Contributions of any kind welcome!
Acknowledgment
This project has been sponsored by ABB Oy and by the Research Council of Finland Centre of Excellence in High-Speed Electromechanical Energy Conversion Systems. The example control methods included in this repository are based on published algorithms (available in textbooks and scientific articles). They do not present any proprietary control software.
Metadata
Release files for motulator 0.15.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| motulator-0.15.1.tar.gz | 31.2 MB | Without provenance | Details for motulator-0.15.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| motulator-0.15.1-py3-none-any.whl | Python 3 | none | any | Details for motulator-0.15.1-py3-none-any.whl |
Total release size: 31.4 MB
Release files / motulator-0.15.1.tar.gz
| Download URL | motulator-0.15.1.tar.gz |
|---|---|
| Size | 31.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1b7d726a8e32ace4a9a925ffa6cad281fe2d6ff03344f4a58d8d7876b9c7eb80
|
|
BLAKE2b-256 checksum How to use checksums |
dcb44557e48505894feb78238cebde72249599ae7bae8c2fe6931e23ba3e5019
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / motulator-0.15.1-py3-none-any.whl
| Download URL | motulator-0.15.1-py3-none-any.whl |
|---|---|
| Size | 164.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2178754f5644781fb3f61f31e3ac68504e64a90028ad167179a1ddfd78b44ac2
|
|
BLAKE2b-256 checksum How to use checksums |
fa191a5202311dcaa9756092803b789ec0f679f5646d606054ae7c59160ec778
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Security for motulator 0.15.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.