Skip to main content

An open source EM FEM simulator in Python

Project description

GitHub License GitHub Release PySimHub PyPI - Downloads DOI

Introduction

LinkedInCover

Hello everybody. Thanks for showing interest in my EM FEM library!

EMerge is a python based FEM EM library for the time harmonic helmholtz formulation. It is thus best suited for Electromagnetic wave phenomenon. You can use it to simulate:

  • RF Filters
  • Signal propagation through PCBs
  • Antennas
  • Optycal systems
  • Arrays and periodic structures
  • Much more!

It is designed to be as easy to use and compatible as possible. It runs on all operating systems allthough some solvers are a bit harder to make work on some systems than others.

EMerge is designed to have your entire simulation start and finish in the same Python script (or more if you want). You require no awkward configuration files, JSON's, external software to do modelling etc. It allows you to do everything in Python:

  • Geometry Creation/description
  • Material assignment
  • Meshing + mesh settings and adaptive mesh refinement
  • Boundary condition setup
  • Solving
  • Post processing and visualization

If you have questions, suggestions, bug reports or just want to hang out, feel free to join the discord!

Discord Invitation

How to install

You can now install the basic version of emerge from PyPi!

pip install emerge

Direct solvers

EMerge solves all systems with direct solvers only. Some are faster than others. Depending on the operating system and hardware you have, some might work better and/or are easier to install than others.

MacOS (ARM)

Single threaded UMFPACK

On MacOS you can install it with the very fast UMFPACK through scikit-umfpack

brew install cmake swig suite-sparse pkg-config #MacOS
sudo apt-get install libsuitesparse-dev #Linux

Then on MacOS do:

export PKG_CONFIG_PATH="/opt/homebrew/lib/pkgconfig:$PKG_CONFIG_PATH"
export CFLAGS="-I/opt/homebrew/include"
export LDFLAGS="-L/opt/homebrew/lib"
export CFLAGS="-Wno-error=int-conversion"

Finally:

pip install meson-python ninja
pip install --no-build-isolation --no-binary=scikit-umfpack scikit-umfpack

note: If you have any corrections to these instructions (for any os) please let me know!

Multi threaded MUMPS

To install the MUMPS solver on MacOS, download the installer directory from my website and follow the instructions:

https://www.emerge-software.com/resources

Windows (x86)

Windows has easy access to the lightning fast PARDISO solver out of the box, no installation needed. If you want to install the UMFPACK solver for distributed sweeps this distribution should work through conda forge:

conda install conda-forge::scikit-umfpack

Otherwise try the solution in the user manual.

https://www.emerge-software.com/resources

GPU bsed CuDSS solver

If you have a new NVidia card you can try the first test implementation of the cuDSS solver. The dependencies can be installed through:

pip install emerge[cudss]

Limitations: * Cupy is currently only supporting 32 bit integer address so large EM problems cannot be correctly solved currently. This is not something I can do anything about.

Required libraries

To run this FEM library you need the following libraries

  • numpy
  • scipy
  • gmsh
  • loguru
  • numba
  • matplotlib (for the matplotlib base display)
  • pyvista (for the PyVista base display)
  • mkl (x86 devices only)
  • emsutil

Optional:

  • scikit-umfpack
  • cudss
  • ezdxf

Resources / Manual

You can find the latest versions of the manual on: https://www.emerge-software.com/resources/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

emerge-2.5.1.tar.gz (889.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

emerge-2.5.1-py3-none-any.whl (388.5 kB view details)

Uploaded Python 3

File details

Details for the file emerge-2.5.1.tar.gz.

File metadata

  • Download URL: emerge-2.5.1.tar.gz
  • Upload date:
  • Size: 889.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for emerge-2.5.1.tar.gz
Algorithm Hash digest
SHA256 723b16d14bf76398be20881ecfd095a32254e0d9b0a7505a449d73253b43ca7f
MD5 5d5a15db1e6a8c541f51261600dfc7be
BLAKE2b-256 d99551d3967c5b54e7cf5f95cc60c0ac1f0e0a9b565b587a3bb915ee95562af3

See more details on using hashes here.

File details

Details for the file emerge-2.5.1-py3-none-any.whl.

File metadata

  • Download URL: emerge-2.5.1-py3-none-any.whl
  • Upload date:
  • Size: 388.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for emerge-2.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 58cd84dc72e2fe7b06a9a1d381c62dfa2c31a1697ab878c53cbf644eb025469d
MD5 9f4d90bf0a47f5631252cf57cf5cec06
BLAKE2b-256 d2d399d921b4ac59e5f10aaa2ae7e3839e4f6cfcfc17522d4e9758ca45c5c035

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page