pyemmo 1.5.0.dev2

PyEMMO is a interface for modeling electrical machines in the open-source FEA software Onelab

PyEMMO

Python Electrical Machine Modelling in ONELAB

PyEMMO is a interface for modeling electrical machines in the open-source FEA software ONELAB. The goal of the project is to automate model creation and the simulation workflow for electrical machines with ONELAB.

Installation

Use the package manager pip to install PyEMMO.

pip install https://github.com/ttz-emo/pyemmo.git

You will need versions of Gmsh and GetDP executables. While Gmsh can be directly installed from pip with the Gmsh Python-API, you will need to download GetDP individually.

[!WARNING] Models created with PyEMMO fail with current GetDP version 3.6.0 due to mesh import error! You can check your GetDP version with getdp --version

Usage

The easiest way to start is by using the Pyleecan project to create a electrical machine instance and feeding it into the PyEMMO-Pyleecan interface.

• Have a look at the Pyleecan tutorials on how to use Pyleecan. Especially the tutorial on "How to define a machine".
• See the Pyleecan API tutorial for detailed instructions on how to create a ONELAB model from a Pyleecan machine object.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Setup

After cloning the repository you should install pre-commit package using pip install pre-commit. After that please update the INSTALL_PYTHON path in the pre-commit hook under "./workingDirectory/pre-commit". Then run the following command to install the Git hooks:

./workingDirectory/install-hooks.sh

Or if you are on Windows:

install-hooks.bat

These hooks make sure you have formatted your files correctly.

License

GPLv3

Publications

• 2023: PyEMMO - a Python based software for the finite element modelling of electrical machines in ONELAB

Run Sphinx to create Documentation

To create or update the documentation you will need to do:

1. Install the doc requirments with: pip install -r requirements-doc.txt.
2. Make sure pyemmo is found by either creating a pyemmo.pth file in the site-packages folder or use pip install -e ..
3. To fully build the documentation including the pyleecan api subpackage you need to install pyleecan. Currently we have to use the Github version since the new release is not out yet: pip install git+https://gitlab.com/Eomys/pyleecan/tree/update-python-version.git
4. Run Sphinx to build the docs e.g. in html doc\make.bat html.

You can run doc\make.bat plane to see the build options. Futher information on building the documentation can be found in the Sphinx documentation.