improver package

improver package#

Subpackages#

Submodules#

Module contents#

Module containing plugin base class.

class BasePlugin[source]#

Bases: ABC

An abstract class for IMPROVER plugins. Subclasses must be callable. We preserve the process method by redirecting to __call__.

_abc_impl = <_abc._abc_data object>#
abstractmethod process(*args, **kwargs)[source]#

Abstract class for rest to implement.

Return type:

Any

class PostProcessingPlugin[source]#

Bases: BasePlugin

An abstract class for IMPROVER post-processing plugins. Makes generalised changes to metadata relating to post-processing.

_abc_impl = <_abc._abc_data object>#
static post_processed_title(cube)[source]#

Updates title attribute on output cube to include “Post-Processed”

example_data_path(*path_to_join)[source]#

Function to generate the path to the data within the improver_example_data repo from the relative path provided.

Parameters:

  • joined (A variable length argument list representing parts of the path to be)

  • data. (to form the full path to the example)

Raises:

ImportError – The improver_example_data package is not available

Returns:

An absolute path to the example data.

Contents
Show Source