diff --git a/README.md b/README.md index efcacdb..cdd8a7d 100644 --- a/README.md +++ b/README.md @@ -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) + +

+ + + + +

PyWinding

+ +

+ A simulation tool for the design and evaluation of induction coils +
+ Report bug + ยท + Request feature +

+

+ +| **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 @@ -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. \ No newline at end of file diff --git a/docs/img/coil.png b/docs/img/coil.png new file mode 100644 index 0000000..3dc78dc Binary files /dev/null and b/docs/img/coil.png differ diff --git a/setup.cfg b/setup.cfg index 3a90c2b..9fa82be 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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