i_multi_array_based_rule

Module for IMultiArrayBasedRule interface

!!! interfaces IMultiArrayBasedRule

IMultiArrayBasedRule (IRule, ABC)

Rule applied to an a set of (named) arrays

Source code in rules/i_multi_array_based_rule.py

class IMultiArrayBasedRule(IRule, ABC):
    """Rule applied to an a set of (named) arrays"""

    @abstractmethod
    def execute(
        self, value_arrays: Dict[str, _xr.DataArray], logger: ILogger
    ) -> _xr.DataArray:
        """Executes the rule based on the provided array"""

execute(self, value_arrays, logger)

Executes the rule based on the provided array

Source code in rules/i_multi_array_based_rule.py

@abstractmethod
def execute(
    self, value_arrays: Dict[str, _xr.DataArray], logger: ILogger
) -> _xr.DataArray:
    """Executes the rule based on the provided array"""