pywinding 0.0.3
A tool for rapidly prototyping wound induction microcoils using Finite Element Method Magnetics (FEMM).
Requires Python: >=3.9

# pywinding
A simulation toolkit for the design and evaluation of induction microcoils using pyFEMM and Finite Element Method Magnetics ([FEMM](https://www.femm.info/wiki/HomePage)).

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15705727.svg)](https://doi.org/10.5281/zenodo.15705727)

## Overview

This software toolkit simplifies the design and simulation of induction microcoils. The toolkit leverages the pyFEMM interface of the Finite Element Method Magnetics software (https://www.femm.info/wiki/HomePage) to allow users to rapidly characterise the magnetic and electrical characteristics of induction microcoils containing permeable magnetic cores. The effect of shape anisotropy of the magnetic material is calculated to yield an *effective permeability* of the magnetic core.

Given a set of user defined coil geometry and simulation parameters the toolkit will:
1. Calculate the remaining mechanical parameters of the coil
2. Build the sensor geometry and a virtual Helmholtz array to apply the stimulus field
3. Apply a magnitude sweep of magnetic flux densities and record the microcoil responses
5. Extract the electrical parameters of the sensor, Resistance (Ohms) and Inductance (Henries)
6. Print and plot the results on-screen
7. Save the results to a .mat file


## Installation

Ensure the FEMM 4.2 software package (available at https://www.femm.info/wiki/HomePage) is installed on your system in the default installation directory `C:\femm42`.

Install the latest version of pywinding from PyPi with:
```python
python -m pip install pywinding
```

##  Usage (command-line)

The pywinding tool can be used directly from the Python interpreter. 

From the interpreter import the pywinding classes for defining the geometry of a coil and the testbench for which to evaluate the sensor:
```python
>>> from pywinding import Coil, Testbench_B_Sweep
```
Define the geometry of an induction microcoil. An example definition is given below
```python
>>> name = 'test_microcoil'
>>> ls = 6.5                    # ls  : length of the sensor coil (millimeters)
>>> ods = 0.5                   # ods : outer diameter of the sensor coil (millimeters)
>>> ids = 0.09                  # ids : inner diameter of the sensor coil (millimeters)
>>> lc = 9                      # lc  : length of the magnetic core (millimeters)
>>> odc = ids                   # idc : inner diameter of the magnetic core (millimeters, typically 0)
>>> idc = 0                     # odc :  outer diameter of the magnetic core (millimeters, typically same as ids)
>>> odw = 0.025                 # odw : outer diameter of the wire used to wind the sensor including insulation (millimeters)
>>> odwc= 0.025                 # odwc : outer diameter of the copper wire cross section only (millimeters)
>>> pf = 1                      # pf  : The packing factor (scalar between 0.0 and 1.0)
>>> ma = 'Hiperco-50'           # ma  : The name of the material used in the core of the microcoil  (must be defined within the FEMM program)
>>> force_n = False             # Set to False if you wish the program to deduce the number of turns based on the provded coil geometry

>>> testcoil = Coil(ls,ids,ods,lc,idc,odc,odw,pf,ma,name, odwc=odwc, explicit_n=force_n)
```
Create an instance of the simulation testbench specifying the test frequency, the range of magnetic flux densities (in tesla) and the number of simulation points within this range:
```python
>>> f_test = 1000    # The stimulus frequency for the simulation
>>> B_start = 1e-9   # The starting flux density (in tesla)
>>> B_end = 1e-6     # The ending flux density (in tesla)
>>> num_points = 10  # The number of simulation points to use in the sweep

>>> tb = Testbench_B_Sweep(f_test, B_start, B_end, num_points)
```
Run the simulation by passing the coil geometry to the testbench:
```python
>>> results = tb.simulate(testcoil, clean_up_femm=False) # Specify the program not to delete the FEMM files once completed
```
Multiple instances of the FEMM tool should launch in the background. The number of instances = number of CPU cores on the system.

Once the simulation is complete you can print the results to the console using:
```python
>>> tb.print_results()   # Print the coil parameters to the console
```
Plotting the results can be performed using:
```python
>>> tb.plot_results()    # Plot the coil response using matplotlib
```
The results can also be saved to a ```.mat``` file using:
```python
>>> tb.save_results()
```

## Tests
The above usage example is available as a script in the ```tests``` folder of the package.


## Accuracy of the tool
Pywinding has been validated by comparing simulation results with those of corresponding physically realised microcoils. 

Simulation results are typically within 5-10% of the real-world measurements which reflects the imperfect nature of the simulation and variations due to material temperature and variabilities in the winding/manufacturing process of real coils. 

This tool should therefore be used as a guide to inform the feasibility of a microcoil design given an application's mechanical and electrical contraints. 

The authors assume no responsibitlity for the accuracy of this simulation tool. If the use of this toolkit contributes to a publication then please acknowledge the authors by name in that publication.