Metadata-Version: 2.1
Name: py2femm
Version: 0.1.0
Summary: Python interface utilities for FEMM simulations
Author: Tamás Orosz
Author-email: tamas.orosz@yahoo.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown

# py2femm

This library aims to provide a dockerizable, Python-based interface for [FEMM](https://www.femm.info/wiki/HomePage), a
popular finite element method-based solver. It provides a GUI to solve two-dimensional electromagnetic and thermal
problems.
It has an officially supported [python interface (pyFEMM)](https://www.femm.info/wiki/pyFEMM). However, it works under
Windows systems only.  
It is possible to run FEMM under Linux operating systems with [Wine](https://www.winehq.org/). However, it does not
support the ActiveX interface, which was used by the original solution.

This project provides a simplified file-based interface for FEMM, which can be used with Wine and under Linux operating systems.
This interface generates a lua file, which the original interpreter of FEMM can use. However, this interface differs
from the original command set in the following points:

- The geometry description is separated from the fields; therefore, if we describe the geometry for a 2D magnetic model,
we can use the same description of the part to create the thermal model.

- Some new commands are introduced, which execute the combination of some straightforward commands.

- Provides an Ubuntu-based dockerized environment to execute the simulations consistently.

# Geometry generation commands

The geometry class contains Node, Line and CircleArc objects. All of the possible modelled geometries should be
described by using these geometrical objects.



