Skip to content

Updated readme #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dreoilin wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updated readme #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07f7e43
Updated readme
dreoilin Jun 26, 2025
6d25d03
Updated setup.cfg
dreoilin Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
# pywinding
Automated winding design for micro coils based on [sensor-toolkit](https://github.com/AlexJaeger/sensor-toolkit)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15705727.svg)](https://doi.org/10.5281/zenodo.15705727)

<p align="center">
<a>
<img src="https://github.com/WiMag-Tracking/PyWinding/blob/main/docs/img/icon.png?raw=true" width="400">
</a>

<h3 align="center">PyWinding</h3>

<p align="center">
A simulation tool for the design and evaluation of induction coils
<br>
<a href="https://www.github.com/WiMag-Tracking/PyWinding/issues/new?template=bug.md">Report bug</a>
·
<a href="https://www.github.com/WiMag-Tracking/PyWinding/issues/new?template=feature.md&labels=feature">Request feature</a>
</p>
</p>

| **Parameter** | **Description** |
|--------------------|--------------------------------------|
| $D_o$ | Total diameter of the sensor |
| $D_i$ | Outer diameter of sensor core only |
| $d_o$ | Total diameter of magnet wire |
| $d_i$ | Diameter of the magnetic wire copper |
| $l_w$ | Length of the winding |
| $l_c$ | Length of the core |

## Introduction

Expand All @@ -17,13 +41,10 @@ Given a set of coil geometry and material specifications the toolkit will:
## Required
Ensure FEMM 4.2 is installed on your system in the default installation directory `C:\femm42`.

Use `test_run_sweep.m` to run a the simulation.
Use `test_Testbench.py` to run a test simulation.
Sensor parameters are specified and explained at top of file.

Use `remove_files.m` to remove all .fem and .ans files from the directory.


## Right to use
If you've been added to this repository feel free to use it in your research project. Do not redistribute this code unless the author gives permission to do so, as this work has not yet been published.
Simulations have been verified to be within 5-10% of the real-world measurements, however the author takes no responsibitlity for the accuracy of this simulation toolkit.
If the use of this toolkit contributes to a publication then please acknowledge the author by name in that publication.
If the use of this toolkit contributes to a publication then please acknowledge the author by name in that publication.
Binary file added docs/img/coil.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ author_email = alexander.jaeger@tyndall.ie
description = Automated parameter extraction for micro coil designs
long_description = file: README.md, LICENSE
long_description_content_type = text/markdown
url = https://github.com/dreoilin/PyWinding
url = https://github.com/WiMag-Tracking/PyWinding
project_urls =
Bug Tracker = https://github.com/madrasalach/PyWinding/issues
Bug Tracker = https://github.com/WiMag-Tracking/PyWinding/issues
classifiers =
Programming Language :: Python :: 3
Operating System :: OS Independent
Expand Down