Metadata-Version: 2.5
Name: FEMMInterpreter
Version: 0.1.1
Summary: A python library for interpreting FEMM solution files
Project-URL: Homepage, https://github.com/wgbowley/FEMMInterpreter
Project-URL: Bug Tracker, https://github.com/wgbowley/FEMMInterpreter/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 
#F3A51C - rich, warm golden-orange 

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 FEMMInterpreter repository `▽`ʃ♡
-->

## Overview

![Status](https://img.shields.io/badge/Status-Active-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)

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

### Proposed Integration

FEMMInterpreter is intended to provide a bridge between FEMM's numerical
solutions and Python-based computational models.

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

---

<!-- Need to update that image before updating to PyPi -->

<div align="center">
  <img 
    src="https://raw.githubusercontent.com/wgbowley/FEMMInterpreter/main/media/dipole_a_potential_plot.png" 
    alt="Magnetic vector potential Plot" style="max-width: 600px"
  >
    <p>
      <em>
      Figure 1: Magnetic vector potential of a dipole extracted from FEMM (.ans)
      </em>
    </p>
</div>

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

## Quick Start

```py
from FEMMInterpreter 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)
```

> [!IMPORTANT]
>
> This tool will focus on the magnetic domain for now, but can be expanded in the future to cover all FEMM solutions.


## Installation

> [!WARNING]
>
> This library is still under development and hasn't been fully documented nor fully test-covered. <br>
> The abstraction boundaries may change with future releases. 

To install,

```
pip install FEMMInterpreter
```

## Documentation

Documentation for the attribute class output can be found [here](docs/attributes.pdf). <br>
Internal documentation can be found within this repo's [issues](https://github.com/wgbowley/FEMMInterpreter/issues).

### Tags
```
LX -> Documentation and project structure
L0 -> Requirements and Objectives
L1 -> Architecture and implementation
L2 -> Validation of the codebase
DS -> Descoped Feature, Descoped Analysis 
```
