Skip to main content

Python Library for Electrical Engineering Computational Analysis

Project description


PyPI version License Code style: black


PYLEECAN objective is to provide a user-friendly, unified, flexible simulation framework for the multiphysic design and optimization of electrical machines and drives based on fully open-source software.

It is meant to be used by researchers, R&D engineers and teachers in electrical engineering, both on standard topologies of electrical machines and on novel topologies (e.g. during a PhD work). An objective of PYLEECAN is that every PhD student should start with PYLEECAN instead of implementing his own scripts (e.g. coupling Scilab or Matlab with Femm).

Getting Started

The procedure to install and use Pyleecan is detailed on pyleecan website


The initial scope of the project is to simulate the electromagnetic performances of the following 2D radial flux machines:

  • Interior, Surface and Surface Inset Permanent Magnet Synchronous Machines (IPMSM, SPMSM, SIPMSM) with inner or outer rotor
  • Squirrel Cage Induction Machines (SCIM) and Doubly Fed Induction Machines (DFIM)
  • Synchro Reluctant Machines (SyRM)
  • Switched Reluctance Machines (SRM).

The project should then address 3D topologies (axial flux machines, claw-pole synchronous machines) and linear machines. On a longer term, PYLEECAN should also include the following five physics with different model granularity (e.g. analytic, semi-analytic, finite element):

  • Electrical
  • Electromagnetics
  • Heat Transfer
  • Structural Mechanics
  • Acoustics

Origin and status of the project (06th October 2020)

EOMYS initiated in 2018 the open-source project named PYLEECAN (Python Library for Electrical Engineering Computational Analysis) under Apache license by releasing a part of MANATEE commercial software scripts. These initial scripts included a fully object-oriented modelling of main radial flux electrical machines, with parameterized geometry. However, PYLEECAN is not an EOMYS-only project, the initial maintainers includes other companies and universities and all contributors are welcome.

Main Features:

  • PYLEECAN is fully coupled to FEMM to carry non-linear magnetostatic analysis including sliding band and symmetries. For now this coupling is available only on Windows.
  • PYLEECAN includes an electrical model to solve the equivalent circuit of PMSM machine by using the FEMM coupling
  • PYLEECAN includes a Graphical User Interface to define main 2D radial flux topologies parametrized geometries (PMSM, IM, SRM, SyRM) including material library.
  • PYLEECAN is coupled to Gmsh 2D/3D finite element mesh generator to run third-party multiphysic solvers.
  • PYLEECAN is coupled to a multiobjective optimization library to carry design optimization of electrical machines.

If you are interested by a topology or a specific model, you can open an issue on this Github repository to talk about it. We will gladly explain how to add it yourself or we will add it to the development list for further release.


Three public and free webinars will be organized by Green Forge Coop and UNICAS University:

  • Friday 16th October 15h-17h (GMT+2): How to use pyleecan (basics)? Pyleecan basics, call of FEMM, use of the GUI
  • Friday 30th October 15h-17h (GMT+1): How to use pyleecan (advanced)? Optimization tools, meshing, plot commands
  • Friday 6th November 15h-17h (GMT+1): How to contribute to pyleecan? Github projects, Object Oriented Programming

The webinar will be based on the tutorials. The registration form is available here

Documentation / Website

For now all the information on the project are available on At this link, you will find the ICEM 2018 publication and the architecture documentation.


You can contact us on Github by opening an issue (to request a feature, ask a question or report a bug) or at that redirect to all the maintainers.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyleecan, version 1.2.1
Filename, size File type Python version Upload date Hashes
Filename, size pyleecan-1.2.1.tar.gz (8.0 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page