Skip to content

Files

Latest commit

e6f6394 · Jan 18, 2020

History

History
81 lines (52 loc) · 2.77 KB

index.rst

File metadata and controls

81 lines (52 loc) · 2.77 KB

What is Magpylib ?

  • Free Python package for calculating magnetic fields of magnets, currents and moments (sources).
  • Provides convenient methods to create, geometrically manipulate, group and visualize assemblies of sources.
  • The magnetic fields are determined from underlying analytical solutions which results in fast computation times and requires little computation power, memory and background knowledge.
  • For high performance computation (e.g. for multivariate parameter space analysis) all functions are also available in vectorized form.

_static/images/index/sourceFundamentals.png

When can you use Magpylib ?

The analytical solutions are only valid if there is little or no material response. This means that whenever there is a lot of demagnetization in permanent magnets or soft magnetic materials like magnetic shields or transformer cores, these computations cannot be used. Magpylib is at its best dealing with air-coils and permanent magnet assemblies (Ferrite, NdFeB, SmCo or similar materials).

Quickstart

Install magpylib with pip: >> pip install magpylib.

Example:

Run this simple code to calculate the magnetic field of a cylindrical magnet.

from magpylib.source.magnet import Cylinder
s = Cylinder( mag = [0,0,350], dim = [4,5])
print(s.getB([4,4,4]))

# Output: [ 5.08641867  5.08641867 -0.60532983]

In this example the cylinder axis is parallel to the z-axis. The diameter and height of the magnet are 4 millimeter and 5 millimeter respectively and the magnet position (=geometric center) is in the origin. The magnetization / remanence field is homogeneous and points in z-direction with an amplitude of 350 millitesla. Finally, the magnetic field B is calculated in units of millitesla at the positition [4,4,4] millimeter.

Example:

The following code calculates the combined field of two magnets. They are geometrically manipulated, the system geometry is displayed together with the field in the xz-plane.

.. plot:: pyplots/examples/01_SimpleCollection.py
   :include-source:


More examples can be found in the Examples Section.

Technical details can be found in the :ref:`docu` .

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: Content:

   _pages/*

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: Library Docstrings:

   _autogen/magpylib
   _autogen/magpylib.source
   _autogen/magpylib.math


Index