gwsumm.plot.registry module

Registry for GWSumm output plot types

All plot types should be registered for easy identification from the configuration INI files

gwsumm.plot.registry.get_plot(name)

Query the registry for the plot class registered to the given name

gwsumm.plot.registry.register_plot(plot, name=None, force=False)

Register a new summary Plot to the given name

Parameters:

namestr

unique descriptive name for this type of plot, must not contain any spaces, e.g. ‘timeseries’

plotclasstype

defining Class for this plot type

forcebool

overwrite existing registration for this type

Raises:

ValueError

if name is already registered and force not given as True