Skip to main content

An open source EM FEM simulator in Python

Project description

DOI

Introduction

Hello everybody. Thanks for showing interest in this repository.

Feel free to download your version of EMerge and start playing around with it! If you have suggestions/changes/questions either use the Github issue system or join the Discord using the following link:

Discord Invitation

How to install

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

pip install emerge

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

brew install cmake swig suite-sparse #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"

Finally:

pip install emerge[umfpack]

Experimental

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]

The scikit-umfpack solver can be installed on Windows as well from binaries with conda. This is a bit more complicated and is described in the installation guide which can be downloaded from the official website:

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

Compatibility

As far as I know, the library should work on all systems. PARDISO is not supported on ARM but the current SuperLU and UMFPACK solvers work on ARM as well. Both SuperLU and UMFPACK can run on multi-processing implementations as long as you do entry-point protection:

import emerge as em

def main():
    # setup simulation

    model.mw.run_sweep(True, ..., multi_processing=True)

if __name__ == "__main__":
    main()

Otherwise, the parallel solver will default to SuperLU which can be slower on larger problems with a very densely connected/compact matrix.

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)
  • cloudpickle
  • mkl (x86 devices only)

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.1.0.tar.gz (458.4 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.1.0-py3-none-any.whl (320.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: emerge-2.1.0.tar.gz
  • Upload date:
  • Size: 458.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for emerge-2.1.0.tar.gz
Algorithm Hash digest
SHA256 f96366b3afb6319a5c68f2d0f1478779482e96c596167f714b4b7ac8af03d623
MD5 ee99b2c8f04275aa8ee5703bcd6ff0d4
BLAKE2b-256 80ffc981af4baa17aa30ec382621b5834a892a2835da9942808f56b4021ecd91

See more details on using hashes here.

File details

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

File metadata

  • Download URL: emerge-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 320.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for emerge-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3884688e623901323058864cc318b24df22b91dd672f8a2b575106601c88b27e
MD5 e9a0f681f2744c9670d6067a56903c98
BLAKE2b-256 ffb533cd63e0ae256bb3158ae837ca0a91c85a7b75b79a33ebea3a0659129283

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