fields class

fields class#

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

Bases: Plugin

Plugin type for generic field data streams.

A DataStream sub-type for reading and writing gridded field data (e.g. background concentrations, 3-D model fields).

Concrete implementations live in pycif/plugins/datastreams/fields/.

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

initiate_template()[source]#

Initialise the Field plugin template.

Loads the registered field module and attaches write and read as bound methods, and fetch as a static function on this instance.