Metadata-Version: 2.5
Name: ifemm
Version: 0.2.0
Summary: A python library for interpreting FEMM solution files
Project-URL: Homepage, https://github.com/wgbowley/ifemm
Project-URL: Bug Tracker, https://github.com/wgbowley/ifemm/issues
Author-email: William Bowley <wgrantbowley@gmail.com>
Maintainer-email: William Bowley <wgrantbowley@gmail.com>
License: MIT License
        
        Copyright (c) 2026 William Bowley
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: FEM,FEMM,Parsing,format
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: numpy>=1.24.0
Requires-Dist: scipy>=1.10.0
Description-Content-Type: text/markdown

<!--
Color Palette:
#FFFFFF - pure white 
#00FFFF - pure, highly saturated shade of Cyan  

It's a simple piece of kit, but being able to integrate
FEMM solutions directly into the pipeline is extremely
useful.

- William Bowley, 2026-08-17

P.S: Thanks for downloading the ifemm repository `▽`ʃ♡
-->

### Overview

![Version](https://img.shields.io/badge/Version-0.2.0-FFFFFF?style=flat-square)
![License](https://img.shields.io/badge/License-MIT-00FFFF?style=flat-square&color=00FFFF)
![Python Version](https://img.shields.io/badge/Python-3.10%2B-FFFFFF?style=flat-square)
[![PyPI Downloads](https://img.shields.io/pepy/dt/femminterpreter?label=downloads\&style=flat-square\&color=00FFFF)](https://pepy.tech/projects/femminterpreter)

A Python library for interpreting Finite Element Method Magnetic (FEMM) files and exposing FEMM solution data 
through a Python attribute-based interface. `ifemm` exposes the `A-field` as `A(x,y)`, independent of planar or axisymmetric coordinate systems.

#### Proposed Integration

```
FEMM Setup & Solve → FEMM (.ans) → ifemm → Reduced Order Models / Analytical Models
```

---

### Example

An example of a dipole being plotted can be found in [/examples](examples/) with `.ans` and `.py` files.

<div align="center">
  <img 
    src="https://raw.githubusercontent.com/wgbowley/FEMMInterpreter/refs/heads/main/media/planar_llc_b_field.png" 
    alt="B-field of transformer" 
    style="max-width: 600px"
  >
  <p>
  <em> B-field of a planar LLC transformer from FEMM (.ans) </em>
  </p>
</div>

---

### Quick Start

```py
from ifemm import Parser

# Imports the parser and parses the .ans file
PATH = "examples/magnetostatic.ans"
data = Parser.open(PATH)

# Result as a float with implicit unit of wb/length_unit
a_potential = data.point_potential(0, 0)
```

---

### Installation

To install,

```
pip install ifemm
```

---

### Documentation

Full documentation is available in the [`docs/`](https://github.com/wgbowley/ifemm/tree/main/docs) folder, including API reference, changelog, and contributors.

---
