simulators class

simulators class#

class pycif.utils.classes.simulators.Simulator(plg_orig=None, orig_name='', **kwargs)[source]#

Bases: Plugin

Plugin type for ensemble or Monte Carlo simulators.

Provides the simul() interface used to run a batch of forward simulations for uncertainty quantification or sensitivity analysis.

Concrete implementations live in pycif/plugins/simulators/.

initiate_template()[source]#

Initialise the Simulator plugin template.

Loads the registered simulator module and attaches simul as a bound method on this instance.

classmethod register_plugin(name, version, module, subtype='', **kwargs)[source]#

Register a module for a plugin and version with possibly options

Parameters:

  • name (str) – name of the plugin

  • version (str) – version of the plugin

  • module (types.ModuleType) – module defining the interface between pyCIF and the plugin

  • plugin_type (str) – type of plugin

  • **kwargs (dictionary) – default options for module

simul(*args, **kwargs)[source]#

Default empty simul method