ifemm 0.2.0__tar.gz

ifemm-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: publish FEMMInterpreter
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+
+    environment:
+      name: pypi
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install build tools
+        run: python -m pip install --upgrade pip build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ifemm-0.2.0/.gitignore

@@ -0,0 +1,11 @@
+# .gitignore
+
+# Ignore Files
+*.pyc
+*.egg-info
+*.fls
+*.log
+*.out
+*.gz
+*.fdb_latexmk
+*.aux

ifemm-0.2.0/.pylintrc

@@ -0,0 +1,18 @@
+# .pylintrc
+
+[MESSAGES CONTROL]
+disable = 
+    R0903,                      # Too few public methods
+    R0911,                      # Too many return statements
+    C0321,                      # Multiple Statements (More than one statement on a single line)
+    R0902,                      # Too many instance attributes
+    E1101,                      # Instance has no member
+
+
+[MASTER]
+ignore-paths=
+    ^.*\.pyi$,
+
+
+[FORMAT]
+max-line-length=100             # Maximum number of characters on a single line.

ifemm-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+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.

ifemm-0.2.0/PKG-INFO

@@ -0,0 +1,120 @@
+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.
+
+---

ifemm-0.2.0/README.md

@@ -0,0 +1,79 @@
+<!--
+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.
+
+---

ifemm-0.2.0/cSpell.json

@@ -0,0 +1,73 @@
+{
+  "version": "0.2",
+  "language": "en-US",
+  "words": [
+    "acsolver",
+    "axisymmetric",
+    "bdry",
+    "bdryname",
+    "bdryprops",
+    "bdrytype",
+    "beginbdry",
+    "beginblock",
+    "begincircuit",
+    "bhpoints",
+    "blockname",
+    "blockprops",
+    "Bowley",
+    "cbar",
+    "circuitname",
+    "circuitprops",
+    "circuittype",
+    "cmap",
+    "coercivity",
+    "colorbar",
+    "conductorprops",
+    "contourf",
+    "Descoped",
+    "endbdry",
+    "endcircuit",
+    "fdb_latexmk",
+    "FEMMInterpreter",
+    "Femm",
+    "figsize",
+    "fontsize",
+    "griddata",
+    "h_cangle",
+    "innerangle",
+    "isort",
+    "lamfill",
+    "lamtype",
+    "lengthunits",
+    "magnetostatic",
+    "magnetostatics",
+    "minangle",
+    "neighbour",
+    "nstrands",
+    "numblocklabels",
+    "numpoints",
+    "numsegments",
+    "numpy",
+    "outerangle",
+    "pointprops",
+    "PrevSoln",
+    "prevtype",
+    "problemtype",
+    "pypa",
+    "pypi",
+    "pylint",
+    "scipy",
+    "tkpoints",
+    "tokei",
+    "totalamps_im",
+    "totalamps_re",
+    "viridis",
+    "xlabel",
+    "ylabel",
+    "numarcsegments",
+    "numholes",
+    "beginpoint",
+    "ifemm",
+    "pylintrc"
+  ]
+}

ifemm-0.2.0/docs/CHANGELOG.md

@@ -0,0 +1,44 @@
+### Changelog
+
+All notable changes to ifemm will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+*(ISO-DATE is used for all updates)*
+
+---
+
+[0.1.1] - 2026-08-18
+
+### Fixed
+- Namespace problem with 0.1.0
+
+---
+
+[0.1.2] - 2026-08-30
+
+### Added
+- Namespace is now `ifemm`
+- Extra constants to the constant files "numarcsegments" & "beginpoint"
+- Updated referencing in `__init__.py` files to `ifemm` instead of `FEMMInterpreter`
+- Improved the readme and /docs file. 
+- Returns the interpolated B field from vector potential A for graphing.
+- Returns the point B field for calculations using finite differences.
+
+### Fixed
+- Missing constants extra when loading solutions that used arc segments
+
+
+[0.1.2] - 2026-09-21
+
+### Added
+- Namespace on pypi is `ifemm` & github is `ifemm`
+
+### Fixed
+- Fixed `axisymmetric` b-field & a-field graphs.
+
+### Removed
+- Removed `point_b(x, y)` for now. As it needs to be reimplemented.
+
+--- 

ifemm-0.2.0/docs/CONTRIBUTORS.md

@@ -0,0 +1,22 @@
+
+## Contributors
+
+`ifemm` is developed using:
+- `pylint` as the linter
+- `radon` as the complexity analyzer
+- `coverage` to check test coverage
+- `tokei` as the code statistics analyzer 
+- `CSpell` for spell checking (Code Spell Checker, Bundled Dictionaries)
+
+> [!note]
+> Ensure that you add words to `ifemm` cSpell.json, not your personal dictionary.
+
+---
+
+My personal VS Code workflow also includes:
+- `Pylance`
+- `Python`
+- `Python Debugger`
+- `Python Environments`
+- `isort`
+- `Python Indent`

ifemm-0.2.0/docs/raws/attributes.tex

@@ -0,0 +1,170 @@
+\documentclass[11pt,a4paper]{article}
+\usepackage[margin=0.8in]{geometry}
+\usepackage{hyperref}
+\usepackage{enumitem}
+\usepackage{titlesec}
+\usepackage{tabularx}
+\usepackage{array}
+\usepackage{booktabs}
+\usepackage{ragged2e}
+
+% Better section formatting
+\titleformat{\section}{\large\bfseries}{}{0em}{}[\titlerule]
+
+% Fix spacing after section titles
+\titlespacing{\section}{0pt}{12pt}{6pt}
+
+% Fix hyperref formatting
+\hypersetup{
+  colorlinks=true,
+  linkcolor=blue,
+  urlcolor=blue,
+}
+
+\begin{document}
+
+% Header
+\begin{center}
+{\LARGE \textbf{ifemm}} \\[4pt]
+{\large Output Class Attributes} \\[4pt]
+{\footnotesize\textbf{Version 0.1-alpha} --- August 18, 2026}
+\end{center}
+
+\section*{Attributes}
+
+\vspace{0.5cm}
+\noindent\textbf{Top-Level}
+
+\begin{table}[h]
+  \centering
+  \renewcommand{\arraystretch}{1.3}
+  \footnotesize
+  \begin{tabularx}{\textwidth}{>{\raggedright\arraybackslash}p{3.5cm} 
+                  >{\raggedright\arraybackslash}p{2.5cm}
+                  >{\raggedright\arraybackslash}X}
+    \toprule
+    \textbf{Attribute} & \textbf{Type} & \textbf{Description} \\
+    \midrule
+    format\_version & float & Format version of the file. \\
+    frequency\_hz & float & Frequency for harmonic problems. \\
+    solver\_precision & float & Computing precision within FEMM\@. \\
+    min\_angle\_deg & float & Angle restriction for the triangulation. \\
+    model\_depth & float & Typical length in z-direction (for 2D planar). \\
+    length\_unit & str & Unit used for lengths (e.g., `millimeters', `inches'). \\
+    problem\_type & str & The 2D problem is either planar or axisymmetric. \\
+    coordinate\_system & str & Definition of the coordinate system. \\
+    comment\_text & str & Problem description. \\
+    vector\_x & list[float] & X-coordinates of the solution points. \\
+    vector\_y & list[float] & Y-coordinates of the solution points. \\
+    vector\_a & list[float] & Magnetic vector potential values at each point. \\
+    \bottomrule
+  \end{tabularx}
+\end{table}
+
+\vspace{0.5cm}
+\noindent\textbf{Materials}
+
+\begin{table}[h]
+  \centering
+  \renewcommand{\arraystretch}{1.3}
+  \footnotesize
+  \begin{tabularx}{\textwidth}{>{\raggedright\arraybackslash}p{3.5cm} 
+                  >{\raggedright\arraybackslash}p{2.5cm}
+                  >{\raggedright\arraybackslash}X}
+    \toprule
+    \textbf{Attribute} & \textbf{Type} & \textbf{Description} \\
+    \midrule
+    name & str & Name of the material. \\
+    permeability & tuple[float, float] & Permeability in x and y directions. \\
+    coercive\_force & float & Coercive force in A/m. \\
+    coercive\_angle & float & Angle of coercive force in degrees. \\
+    current\_density & tuple[float, float] & Real and imaginary current density. \\
+    conductivity & float & Electrical conductivity in S/m. \\
+    lamination\_thickness & float & Lamination thickness in mm. \\
+    hysteresis\_angle & float & Hysteresis angle for AC analysis. \\
+    hysteresis\_angle\_x & float & Hysteresis angle in x-direction. \\
+    hysteresis\_angle\_y & float & Hysteresis angle in y-direction. \\
+    lamination\_type & int & Type of lamination. \\
+    lamination\_fill & float & Lamination fill factor. \\
+    num\_strands & int & Number of strands in a stranded conductor. \\
+    wire\_diameter & float & Wire diameter in mm. \\
+    bh\_curve & list[tuple] & B-H curve data points (H, B). \\
+    \bottomrule
+  \end{tabularx}
+\end{table}
+
+\newpage
+
+\vspace{0.5cm}
+\noindent\textbf{Boundaries}
+
+\begin{table}[h]
+  \centering
+  \renewcommand{\arraystretch}{1.3}
+  \footnotesize
+  \begin{tabularx}{\textwidth}{>{\raggedright\arraybackslash}p{3.5cm} 
+                  >{\raggedright\arraybackslash}p{2.5cm}
+                  >{\raggedright\arraybackslash}X}
+    \toprule
+    \textbf{Attribute} & \textbf{Type} & \textbf{Description} \\
+    \midrule
+    name & str & Name of the boundary condition. \\
+    boundary\_type & int & Boundary type \\
+    prescribed\_a & float & Prescribed A value. \\
+    prescribed\_a\_x & float & Prescribed A x-component. \\
+    prescribed\_a\_y & float & Prescribed A y-component. \\
+    phase\_angle & float & Phase angle in degrees for AC analysis (Phi). \\
+    mixed\_c0 & float & Mixed boundary C0 coefficient real part. \\
+    mixed\_c0\_imag & float & Mixed boundary C0 coefficient imaginary part. \\
+    mixed\_c1 & float & Mixed boundary C1 coefficient real part. \\
+    mixed\_c1\_imag & float & Mixed boundary C1 coefficient imaginary part. \\
+    mu\_ssd & float & Relative permeability for Small Skin Depth boundary (Mu). \\
+    sigma\_ssd & float & Conductivity in MS/m for Small Skin Depth boundary (Sig). \\
+    inner\_angle & float & Inner angle for periodic boundary (degrees). \\
+    outer\_angle & float & Outer angle for periodic boundary (degrees). \\
+    \bottomrule
+  \end{tabularx}
+\end{table}
+
+\vspace{0.5cm}
+\noindent\textbf{Circuits}
+
+\begin{table}[h]
+  \centering
+  \renewcommand{\arraystretch}{1.3}
+  \footnotesize
+  \begin{tabularx}{\textwidth}{>{\raggedright\arraybackslash}p{3.5cm} 
+                  >{\raggedright\arraybackslash}p{2.5cm}
+                  >{\raggedright\arraybackslash}X}
+    \toprule
+    \textbf{Attribute} & \textbf{Type} & \textbf{Description} \\
+    \midrule
+    name & str & Name of the circuit. \\
+    total\_amps\_real & float & Total current (real component) in amps. \\
+    total\_amps\_imag & float & Total current (imaginary component) in amps. \\
+    circuit\_type & int & Type of circuit. \\
+    \bottomrule
+  \end{tabularx}
+\end{table}
+
+\vspace{0.5cm}
+\noindent\textbf{Methods}
+
+\begin{table}[h]
+  \centering
+  \renewcommand{\arraystretch}{1.3}
+  \footnotesize
+  \begin{tabularx}{\textwidth}{>{\raggedright\arraybackslash}p{3.5cm} 
+                  >{\raggedright\arraybackslash}p{3cm}
+                  >{\raggedright\arraybackslash}X}
+    \toprule
+    \textbf{Method} & \textbf{Parameters} & \textbf{Description} \\
+    \midrule
+    point\_potential & x: float, y: float & Returns A at point (x, y). \\
+    field\_potential & resolution: int = 300 & Returns (x\_space, y\_space, a\_grid). \\
+    field\_b & resolution: int = 300 & Returns (x\_space, y\_space, bx, by). \\
+    \bottomrule
+  \end{tabularx}
+\end{table}
+
+\end{document}

ifemm-0.2.0/docs/readme.md

@@ -0,0 +1,35 @@
+### Documentation
+
+The changelog can be found here: [CHANGELOG.md](./CHANGELOG.md)
+
+The FEMM file format specification can be found [here](references/FEMM_format.pdf), 
+and the output attribute class documentation can be found [here](attributes.pdf).
+
+---
+
+### Mathematical
+*Work in progress*
+
+> The `point_potential` method uses nearest-neighbour interpolation to
+> calculate the vector potential at a point. <br>
+
+> The `field_potential` method uses linear interpolation to construct the
+> `A-field` space for graphing.
+
+---
+
+### Internal Documentation
+
+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 
+```
+
+---