Plugin

mrfmsim is designed as a platform for different groups to build and collaborate on simulation experiments. The MRFM community employs different experimental setups. The plugin system is designed to allow other groups to develop their sub-packages and share them with the community. These plugin packages can contain experiments or additional features to add to the mrfmsim platform. The plugin system also simplifies the user experience by combining all modules under one mrfmsim namespace.

Metadata

mrfmsim searches the directory for packages with plugin metadata specified as “mrfmsim-plugin”. This can be achieved in the pyproject.toml:

[project.entry-points.'mrfmsim-plugin']
test = 'mrfmsim-test'

Or in the poetry pyproject.toml:

[tool.poetry.plugins."mrfmsim-plugin"]
"test" = "mrfmsim_test"

Different namespaces can be added to the mrfmsim-plugin group. For example,

[project.entry-points.’mrfmsim-plugin’] experiment = ‘mrfmsim_marohn.experiment’ modifier = ‘mrfmsim_marohn.modifier’

Naming

It is recommended to use the name prefix mrfmsim_ for the plugin package, with a unique name. For plugins that contain duplicated object names, the object name will be prefixed with the plugin name. For example, if the plugin package name is mrfmsim_marohn, a duplicated object name experiment will be renamed to marohn_experiment.

Register object

Not all objects in a module need to be loaded by mrfmsim. To register objects, add the objects to the list __mrfmsim_plugin__ in the module.

For example, to register the CermitESR and IBMCyclic objects in the module mrfmsim_marohn.experiment, define __mrfmsim_plugin__ in mrfmsim_marohn/experiment.py:

__mrfmsim_plugin__ = ['CermitESR', 'IBMCyclic']

plugin module

mrfmsim.plugin.load_plugins(host_module, entry_point_group)

Load plugins into mrfmsim main package.

The plugin is loaded at startup. The loading is done by searching for the entry point of installed packages. The name of the entry point is the attribute in mrfmsim to access the plugin. If the plugin with the same name is already loaded, the plugin will be renamed by the name of the plugin and the module name.

..Note::

Currently, there is no option to block certain plugins.

Parameters:

mrfmsim_module (list) – mrfmsim module