Metadata-Version: 2.1
Name: pypeec
Version: 4.4.0
Summary: PyPEEC - 3D PEEC Solver
Home-page: https://github.com/otvam/pypeec
Author: Thomas Guillod
Author-email: guillod@otvam.ch
Maintainer: Thomas Guillod
Maintainer-email: guillod@otvam.ch
License: MPL-2.0
Project-URL: Repository, https://github.com/otvam/pypeec
Project-URL: Releases, https://github.com/otvam/pypeec/releases
Project-URL: Issues, https://github.com/otvam/pypeec/issues
Project-URL: Tags, https://github.com/otvam/pypeec/tags
Keywords: PyPEEC,FFT,PEEC,3D,voxel,conductor,electric,magnetic,field simulation,maxwell equations,frequency domain,power electronics
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Natural Language :: English
Classifier: Environment :: Console
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: PyYAML >=6.0
Requires-Dist: joblib >=1.3
Requires-Dist: numpy >=1.24
Requires-Dist: scipy >=1.9
Requires-Dist: matplotlib >=3.7
Requires-Dist: shapely >=2.0
Requires-Dist: rasterio >=1.3
Requires-Dist: Pillow >=10.0
Requires-Dist: vtk >=9.2
Requires-Dist: pyvista >=0.40
Requires-Dist: pyvistaqt >=0.11
Requires-Dist: PyQt5 >=5.15

# PyPEEC - 3D PEEC Solver

> * **Website: [pypeec.otvam.ch](https://pypeec.otvam.ch)**
> * **Repository: [github.com/otvam/pypeec](https://github.com/otvam/pypeec)**

## Summary

**PyPEEC** is a **3D quasi-magnetostatic field solver** with the following characteristics:
* **PEEC method** with **FFT acceleration**
* Representation of the **geometry** with **3D voxels**
* **Multithreading and GPU acceleration** are available
* **Fast** with **moderate memory** requirements
* Import the **geometry** from **STL**, **PNG**, and **GERBER** files
* Draw the **geometry** with stacked 2D **vector shapes** or **voxel indices**
* **Pure Python** and **open source** implementation
* Can be used from the **command line**
* Can be used with **Jupyter notebooks**
* Advanced **plotting** capabilities

**PyPEEC** solves the following **3D quasi-magnetostatic problems**:
* Frequency domain solution (DC and AC)
* Conductive and magnetic domains (ideal or lossy)
* Connection of current and voltage sources
* Extraction of the loss and energy densities
* Extraction of the current density, flux density, and potential
* Extraction of the terminal voltage, current, and power
* Computation of the free-space magnetic field 

**PyPEEC** has the following **limitations**:
* No capacitive effects
* No dielectric domains
* No advanced boundaries conditions
* No model order reduction techniques
* Limited to voxel geometries

The **PyPEEC** package contains the following tools:
* **mesher**: create a 3D voxel structure from STL or PNG files
* **viewer**: visualization of the 3D voxel structure
* **solver**: solver for the magnetic field problem
* **plotter**: visualization of the problem solution

## Project Links

* Website: https://pypeec.otvam.ch
* Repository: https://github.com/otvam/pypeec
* Releases: https://github.com/otvam/pypeec/releases
* Tags: https://github.com/otvam/pypeec/tags
* Issues: https://github.com/otvam/pypeec/issues
* PyPi: https://pypi.org/project/pypeec

## Credits

The FFT-accelerated PEEC method with voxels has been first described and implemented in:
* Torchio, R., IEEE TPEL, 10.1109/TPEL.2021.3092431, 2022
* Torchio, R., https://github.com/UniPD-DII-ETCOMP/FFT-PEEC

Other interesting papers and codes about similar methods:
* Yucel, A., IEEE TMTT, 10.1109/TMTT.2017.2785842, 2018
* Bettini, P., IOP, 10.1088/1361-6587/abce8f, 2020
* Marconato, N., ICECCME, 10.1109/ICECCME52200.2021.9590864, 2021
* Yucel, A., https://github.com/acyucel/VoxHenry

PyPEEC was created at **Dartmouth College** by the research group of **Prof. Sullivan**:
* Dartmouth College, NH, USA: https://dartmouth.edu
* Dartmouth Engineering: https://engineering.dartmouth.edu
* PMIC: https://pmic.engineering.dartmouth.edu

## Author

* **Thomas Guillod**
* Email: guillod@otvam.ch
* Website: https://otvam.ch

## Copyright

> (c) 2023 - Thomas Guillod - Dartmouth College
> 
>  This Source Code Form is subject to the terms of the Mozilla Public
>  License, v. 2.0. If a copy of the MPL was not distributed with this
>  file, You can obtain one at http://mozilla.org/MPL/2.0/.
