magpylib wrapper#

Defines a class allowing to wrap a magpylib object into a MagneticField object compatible with atomsmltr

see: https://magpylib.readthedocs.io

class atomsmltr.environment.fields.magnetic.magpylib.MagpylibWrapper(magpy_object, tag: str = None)[source]#

Bases: MagneticField

A wrapper for magpylib objects

Parameters:

  • magpy_object (magpy_object) – the object to wrap

  • tag (str, optional) – the field tag, by default None

gen_infostring_obj()[source]#

Generates an info string object

property type#

a description of the object type

Type:

str