datastreams class

class pycif.utils.classes.datastreams.DataStream(plg_orig=None, orig_name='', **kwargs)

Bases: Plugin

Plugin type for data streams (meteo, flux, background, field).

Provides read, write and optionally fetch methods for reading and writing model input/output data to and from files.

Concrete implementations live in pycif/plugins/datastreams/.

classmethod register_plugin(name, version, module, subtype='', **kwargs)

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()

Initialise the DataStream plugin template.

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