Metadata-Version: 2.4
Name: coil-geom
Version: 0.2.2
Summary: Parametric coil and inductor geometry generator
Author: Uisang Hwang
Project-URL: Homepage, https://github.com/uhwang/Coil-Geom
Project-URL: Bug Tracker, https://github.com/uhwang/Coil-Geom/issues
Project-URL: Repository, https://github.com/uhwang/Coil-Geom
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: numpy

![PyPI - Version](https://img.shields.io/pypi/v/coil-geom)
![PyPI - License](https://img.shields.io/pypi/l/coil-geom)

# coil-geom

**coil-geom** is a Python package for generating and visualizing **coil and inductor geometries** using clean, parametric definitions.  
It is designed for engineering, scientific visualization, and symbolic / schematic-style plotting.

- Pure geometry first (NumPy-friendly)
- Easy plotting with Matplotlib
- Suitable for electronics, physics, and CAD-style workflows

---

## 🔗 Project Links
* **GitHub Repository**: [https://github.com/uhwang/Coil-Geom](https://github.com/uhwang/Coil-Geom)
* **PyPI Page**: [https://pypi.org/project/coil-geom/](https://pypi.org/project/coil-geom/)
* **Issue Tracker**: [Report a bug](https://github.com/uhwang/Coil-Geom/issues)
## Installation

```bash
pip install coil-geom
```

# Mathematical Background
<p align="center">
  <img src="https://raw.githubusercontent.com/uhwang/Coil-Geom/main/images/coil-diag-01.jpg" width="90%" />
  <img src="https://raw.githubusercontent.com/uhwang/Coil-Geom/main/images/coil-diag-02.jpg" width="90%" />
  <img src="https://raw.githubusercontent.com/uhwang/Coil-Geom/main/images/coil-diag-03.jpg" width="90%" />
  <img src="https://raw.githubusercontent.com/uhwang/Coil-Geom/main/images/coil-diag-04.jpg" width="90%" />
  <img src="https://raw.githubusercontent.com/uhwang/Coil-Geom/main/images/coil-diag-05.jpg" width="90%" />
  <img src="https://raw.githubusercontent.com/uhwang/Coil-Geom/main/images/coil-diag-06.jpg" width="90%" />  
</p>

```Python
import matplotlib.pyplot as plt
import coil_geom as cg

coil = cg.CoilGeom()
xc, yc = coil.circle_coil()
xe, ye = coil.ellipse_coil()
xu, yu = coil.circle_coil(p_dist=-0.7)

fig, axs = plt.subplots(nrows=3, ncols=1, sharex=True, figsize=(8, 6))
fig.suptitle('Circle & Ellipse Coil Geometry')
axs[0].plot(xc, yc)
axs[1].plot(xe, ye)
axs[2].plot(xu, yu)

plt.show()
```
