ExternalRunner#

class micromagneticmodel.ExternalRunner#

Methods

`__dir__`	Default dir() implementation.
`__eq__`	Return self==value.
`__repr__`	Return repr(self).
`call`	Call an external simulation package by passing `argstr` to it.

Properties

Name of the external simulation package.

call(argstr, need_stderr=False, verbose=1, total=None, glob_name='', **kwargs)#

Call an external simulation package by passing argstr to it.

Parameters:

argstr (str) – Argument string passed to the external package.
need_stderr (bool, optional) – If need_stderr=True, standard error is captured. Defaults to False.
verbose (int, optional) – If verbose=0, no output is printed. For verbose=1 information about the runner and the runtime is printed to stdout. For verbose=2 a progress bar is displayed for time drives. Note that this information only relies on the number of magnetisation snapshots already saved to disk and therefore only gives a rough indication of progress. Defaults to 1.
total (int, optional) – Number of magnetisation snapshots that the external package writes during the simulation. This information is used to update the progress bar.
glob_name (str, optional) – Glob expression to find the magnetisation snapshots that the external package writes during the simulation. This information is used to update the progress bar.

Raises:

RuntimeError – If an error occured.

Returns:

Return code of the runner, 0 if the run was successful.

Return type:

int