# *motulator:* Motor Drive Simulator in Python
[](https://zenodo.org/doi/10.5281/zenodo.10223090)
[](https://github.com/Aalto-Electric-Drives/motulator/actions/workflows/update_gh-pages.yml)
[](https://github.com/Aalto-Electric-Drives/motulator/blob/main/LICENSE)
[](https://pypi.org/project/motulator/)
[](#contributors-)
Introduction
------------
This open-source software includes simulation models for an induction motor, a synchronous reluctance motor, and a permanent-magnet synchronous motor. The motor models are simulated in the continuous-time domain while the control algorithms run in discrete time. The default solver is the explicit Runge-Kutta method of order 5(4) from scipy.integrate.solve_ivp. Simple control algorithms are provided as examples. The documentation is available here:
https://aalto-electric-drives.github.io/motulator/
Installation
------------
This software can be installed using pip:
```bash
pip install motulator
```
Alternatively, the repository can be cloned:
https://aalto-electric-drives.github.io/motulator/installation.html
Usage
-----
The drive system, controller, reference sequences etc. are easy to configure. As a starting point, example scripts and Jupyter notebooks can be downloaded here:
https://aalto-electric-drives.github.io/motulator/auto_examples/index.html
New system models and controllers can be developed using the existing ones as templates.
Contributing
------------
If you'd like to help us develop motulator, please have a look at these [guidelines](https://github.com/Aalto-Electric-Drives/motulator/blob/main/CONTRIBUTING.md) first.
Contributors
------------
Thanks go to these wonderful people:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/lauritapio"><img src="https://avatars.githubusercontent.com/u/85596019?v=4?s=50" width="50px;" alt="Lauri Tiitinen"/><br /><sub><b>Lauri Tiitinen</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/commits?author=lauritapio" title="Code">💻</a> <a href="#ideas-lauritapio" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-lauritapio" title="Examples">💡</a> <a href="#mentoring-lauritapio" title="Mentoring">🧑🏫</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/HannuHar"><img src="https://avatars.githubusercontent.com/u/96597650?v=4?s=50" width="50px;" alt="HannuHar"/><br /><sub><b>HannuHar</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/commits?author=HannuHar" title="Code">💻</a> <a href="https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3AHannuHar" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://research.aalto.fi/en/persons/marko-hinkkanen"><img src="https://avatars.githubusercontent.com/u/76600872?v=4?s=50" width="50px;" alt="Marko Hinkkanen"/><br /><sub><b>Marko Hinkkanen</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/commits?author=mhinkkan" title="Code">💻</a> <a href="#ideas-mhinkkan" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-mhinkkan" title="Examples">💡</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/silundbe"><img src="https://avatars.githubusercontent.com/u/81169347?v=4?s=50" width="50px;" alt="silundbe"/><br /><sub><b>silundbe</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/commits?author=silundbe" title="Code">💻</a> <a href="#example-silundbe" title="Examples">💡</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/JoonaKukkonen"><img src="https://avatars.githubusercontent.com/u/85099403?v=4?s=50" width="50px;" alt="JoonaKukkonen"/><br /><sub><b>JoonaKukkonen</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/commits?author=JoonaKukkonen" title="Code">💻</a> <a href="#infra-JoonaKukkonen" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jarno-k"><img src="https://avatars.githubusercontent.com/u/84438313?v=4?s=50" width="50px;" alt="jarno-k"/><br /><sub><b>jarno-k</b></sub></a><br /><a href="#ideas-jarno-k" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/angelicaiaderosa"><img src="https://avatars.githubusercontent.com/u/112799415?v=4?s=50" width="50px;" alt="angelicaiaderosa"/><br /><sub><b>angelicaiaderosa</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/commits?author=angelicaiaderosa" title="Code">💻</a> <a href="#example-angelicaiaderosa" title="Examples">💡</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://www.kth.se/profile/lucap"><img src="https://avatars.githubusercontent.com/u/64190518?v=4?s=50" width="50px;" alt="Luca Peretti"/><br /><sub><b>Luca Peretti</b></sub></a><br /><a href="#ideas-lucaperetti" title="Ideas, Planning, & Feedback">🤔</a> <a href="#promotion-lucaperetti" title="Promotion">📣</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/GianmarioPellegrinoPolito"><img src="https://avatars.githubusercontent.com/u/70333484?v=4?s=50" width="50px;" alt="GianmarioPellegrinoPolito"/><br /><sub><b>GianmarioPellegrinoPolito</b></sub></a><br /><a href="#data-GianmarioPellegrinoPolito" title="Data">🔣</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/SimFerr"><img src="https://avatars.githubusercontent.com/u/67151973?v=4?s=50" width="50px;" alt="Simone Ferrari"/><br /><sub><b>Simone Ferrari</b></sub></a><br /><a href="#data-SimFerr" title="Data">🔣</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Jialed0303"><img src="https://avatars.githubusercontent.com/u/118135952?v=4?s=50" width="50px;" alt="Jialed0303"/><br /><sub><b>Jialed0303</b></sub></a><br /><a href="#ideas-Jialed0303" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/murgui"><img src="https://avatars.githubusercontent.com/u/29175623?v=4?s=50" width="50px;" alt="murgui"/><br /><sub><b>murgui</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3Amurgui" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/iam-nithin-10"><img src="https://avatars.githubusercontent.com/u/125553207?v=4?s=50" width="50px;" alt="Nithin Valiyaveettil Sadanandan"/><br /><sub><b>Nithin Valiyaveettil Sadanandan</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3Aiam-nithin-10" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/saarela"><img src="https://avatars.githubusercontent.com/u/10281832?v=4?s=50" width="50px;" alt="saarela"/><br /><sub><b>saarela</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3Asaarela" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/UshnishChowdhury"><img src="https://avatars.githubusercontent.com/u/35863166?v=4?s=50" width="50px;" alt="Ushnish"/><br /><sub><b>Ushnish</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3AUshnishChowdhury" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Francesco-Lelli"><img src="https://avatars.githubusercontent.com/u/127111681?v=4?s=50" width="50px;" alt="Francesco-Lelli"/><br /><sub><b>Francesco-Lelli</b></sub></a><br /><a href="https://github.com/Aalto-Electric-Drives/motulator/commits?author=Francesco-Lelli" title="Code">💻</a> <a href="#example-Francesco-Lelli" title="Examples">💡</a> <a href="#ideas-Francesco-Lelli" title="Ideas, Planning, & Feedback">🤔</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Acknowledgement
---------------
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "motulator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "control, electric, inverter, machine, motor, power, simulation",
"author": null,
"author_email": "Marko Hinkkanen <marko.hinkkanen@aalto.fi>",
"download_url": "https://files.pythonhosted.org/packages/98/87/f96284d5185bfa2beb69cfdd295dc6d6a6146790e1dccf45024a45679526/motulator-0.2.0.tar.gz",
"platform": null,
"description": "# *motulator:* Motor Drive Simulator in Python\n[](https://zenodo.org/doi/10.5281/zenodo.10223090)\n[](https://github.com/Aalto-Electric-Drives/motulator/actions/workflows/update_gh-pages.yml)\n[](https://github.com/Aalto-Electric-Drives/motulator/blob/main/LICENSE)\n[](https://pypi.org/project/motulator/)\n[](#contributors-)\n\nIntroduction\n------------\nThis open-source software includes simulation models for an induction motor, a synchronous reluctance motor, and a permanent-magnet synchronous motor. The motor models are simulated in the continuous-time domain while the control algorithms run in discrete time. The default solver is the explicit Runge-Kutta method of order 5(4) from scipy.integrate.solve_ivp. Simple control algorithms are provided as examples. The documentation is available here:\n\nhttps://aalto-electric-drives.github.io/motulator/\n\nInstallation\n------------\nThis software can be installed using pip: \n\n```bash\npip install motulator\n```\nAlternatively, the repository can be cloned:\n\nhttps://aalto-electric-drives.github.io/motulator/installation.html\n\nUsage\n-----\nThe drive system, controller, reference sequences etc. are easy to configure. As a starting point, example scripts and Jupyter notebooks can be downloaded here:\n\nhttps://aalto-electric-drives.github.io/motulator/auto_examples/index.html\n\nNew system models and controllers can be developed using the existing ones as templates.\n\nContributing\n------------\nIf you'd like to help us develop motulator, please have a look at these [guidelines](https://github.com/Aalto-Electric-Drives/motulator/blob/main/CONTRIBUTING.md) first.\n\nContributors\n------------\nThanks go to these wonderful people:\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/lauritapio\"><img src=\"https://avatars.githubusercontent.com/u/85596019?v=4?s=50\" width=\"50px;\" alt=\"Lauri Tiitinen\"/><br /><sub><b>Lauri Tiitinen</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/commits?author=lauritapio\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#ideas-lauritapio\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#example-lauritapio\" title=\"Examples\">\ud83d\udca1</a> <a href=\"#mentoring-lauritapio\" title=\"Mentoring\">\ud83e\uddd1\u200d\ud83c\udfeb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/HannuHar\"><img src=\"https://avatars.githubusercontent.com/u/96597650?v=4?s=50\" width=\"50px;\" alt=\"HannuHar\"/><br /><sub><b>HannuHar</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/commits?author=HannuHar\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3AHannuHar\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://research.aalto.fi/en/persons/marko-hinkkanen\"><img src=\"https://avatars.githubusercontent.com/u/76600872?v=4?s=50\" width=\"50px;\" alt=\"Marko Hinkkanen\"/><br /><sub><b>Marko Hinkkanen</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/commits?author=mhinkkan\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#ideas-mhinkkan\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#example-mhinkkan\" title=\"Examples\">\ud83d\udca1</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/silundbe\"><img src=\"https://avatars.githubusercontent.com/u/81169347?v=4?s=50\" width=\"50px;\" alt=\"silundbe\"/><br /><sub><b>silundbe</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/commits?author=silundbe\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#example-silundbe\" title=\"Examples\">\ud83d\udca1</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/JoonaKukkonen\"><img src=\"https://avatars.githubusercontent.com/u/85099403?v=4?s=50\" width=\"50px;\" alt=\"JoonaKukkonen\"/><br /><sub><b>JoonaKukkonen</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/commits?author=JoonaKukkonen\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#infra-JoonaKukkonen\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">\ud83d\ude87</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/jarno-k\"><img src=\"https://avatars.githubusercontent.com/u/84438313?v=4?s=50\" width=\"50px;\" alt=\"jarno-k\"/><br /><sub><b>jarno-k</b></sub></a><br /><a href=\"#ideas-jarno-k\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/angelicaiaderosa\"><img src=\"https://avatars.githubusercontent.com/u/112799415?v=4?s=50\" width=\"50px;\" alt=\"angelicaiaderosa\"/><br /><sub><b>angelicaiaderosa</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/commits?author=angelicaiaderosa\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#example-angelicaiaderosa\" title=\"Examples\">\ud83d\udca1</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://www.kth.se/profile/lucap\"><img src=\"https://avatars.githubusercontent.com/u/64190518?v=4?s=50\" width=\"50px;\" alt=\"Luca Peretti\"/><br /><sub><b>Luca Peretti</b></sub></a><br /><a href=\"#ideas-lucaperetti\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#promotion-lucaperetti\" title=\"Promotion\">\ud83d\udce3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/GianmarioPellegrinoPolito\"><img src=\"https://avatars.githubusercontent.com/u/70333484?v=4?s=50\" width=\"50px;\" alt=\"GianmarioPellegrinoPolito\"/><br /><sub><b>GianmarioPellegrinoPolito</b></sub></a><br /><a href=\"#data-GianmarioPellegrinoPolito\" title=\"Data\">\ud83d\udd23</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/SimFerr\"><img src=\"https://avatars.githubusercontent.com/u/67151973?v=4?s=50\" width=\"50px;\" alt=\"Simone Ferrari\"/><br /><sub><b>Simone Ferrari</b></sub></a><br /><a href=\"#data-SimFerr\" title=\"Data\">\ud83d\udd23</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Jialed0303\"><img src=\"https://avatars.githubusercontent.com/u/118135952?v=4?s=50\" width=\"50px;\" alt=\"Jialed0303\"/><br /><sub><b>Jialed0303</b></sub></a><br /><a href=\"#ideas-Jialed0303\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/murgui\"><img src=\"https://avatars.githubusercontent.com/u/29175623?v=4?s=50\" width=\"50px;\" alt=\"murgui\"/><br /><sub><b>murgui</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3Amurgui\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/iam-nithin-10\"><img src=\"https://avatars.githubusercontent.com/u/125553207?v=4?s=50\" width=\"50px;\" alt=\"Nithin Valiyaveettil Sadanandan\"/><br /><sub><b>Nithin Valiyaveettil Sadanandan</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3Aiam-nithin-10\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/saarela\"><img src=\"https://avatars.githubusercontent.com/u/10281832?v=4?s=50\" width=\"50px;\" alt=\"saarela\"/><br /><sub><b>saarela</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3Asaarela\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/UshnishChowdhury\"><img src=\"https://avatars.githubusercontent.com/u/35863166?v=4?s=50\" width=\"50px;\" alt=\"Ushnish\"/><br /><sub><b>Ushnish</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/issues?q=author%3AUshnishChowdhury\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Francesco-Lelli\"><img src=\"https://avatars.githubusercontent.com/u/127111681?v=4?s=50\" width=\"50px;\" alt=\"Francesco-Lelli\"/><br /><sub><b>Francesco-Lelli</b></sub></a><br /><a href=\"https://github.com/Aalto-Electric-Drives/motulator/commits?author=Francesco-Lelli\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#example-Francesco-Lelli\" title=\"Examples\">\ud83d\udca1</a> <a href=\"#ideas-Francesco-Lelli\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\nAcknowledgement\n---------------\nThis 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.\n",
"bugtrack_url": null,
"license": null,
"summary": "Motor Drive Simulator in Python",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://aalto-electric-drives.github.io/motulator/",
"Homepage": "https://github.com/Aalto-Electric-Drives/motulator"
},
"split_keywords": [
"control",
" electric",
" inverter",
" machine",
" motor",
" power",
" simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce7c4cf311dc44b5c778ece176ca734259f6f8191be1126b4ccab87426db42cd",
"md5": "e389cbd942cd7085fc2c3bf1b9d9bc1e",
"sha256": "08c64779fd5b2693ab691e62248ec2114a901d0aa4d7974a17fad99b2c36168a"
},
"downloads": -1,
"filename": "motulator-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e389cbd942cd7085fc2c3bf1b9d9bc1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 61827,
"upload_time": "2024-05-08T09:28:33",
"upload_time_iso_8601": "2024-05-08T09:28:33.762763Z",
"url": "https://files.pythonhosted.org/packages/ce/7c/4cf311dc44b5c778ece176ca734259f6f8191be1126b4ccab87426db42cd/motulator-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9887f96284d5185bfa2beb69cfdd295dc6d6a6146790e1dccf45024a45679526",
"md5": "941d34b716baee17d259e4c19302898e",
"sha256": "2221ce37d6d0680a02a6e0db2d2625bad4fdd89dc3d00adf092177f3940d4d6d"
},
"downloads": -1,
"filename": "motulator-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "941d34b716baee17d259e4c19302898e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27865139,
"upload_time": "2024-05-08T09:28:35",
"upload_time_iso_8601": "2024-05-08T09:28:35.508864Z",
"url": "https://files.pythonhosted.org/packages/98/87/f96284d5185bfa2beb69cfdd295dc6d6a6146790e1dccf45024a45679526/motulator-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 09:28:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Aalto-Electric-Drives",
"github_project": "motulator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "motulator"
}
JSON
