Skip to content

quality_management

Classes:

Name Description
QualityManagement

Main class for orchestrating the dispatch of QualityCheckers and

Classes#

QualityManagement #

Bases: BaseModel

Main class for orchestrating the dispatch of QualityCheckers and QualityHandlers.

Methods:

Name Description
manage

Runs the registered QualityManagers on the dataset.

Attributes:

Name Type Description
managers List[QualityManager]

The list of QualityManagers that should be run.

Attributes#

managers instance-attribute #
managers: List[QualityManager]

The list of QualityManagers that should be run.

Functions#

manage #
manage(dataset: Dataset) -> xr.Dataset

Runs the registered QualityManagers on the dataset.

Parameters:

Name Type Description Default
dataset Dataset

The dataset to apply quality checks and controls to.

 required

Returns:

Type Description
Dataset

xr.Dataset: The quality-checked dataset.
Source code in tsdat/qc/base/quality_management.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
def manage(self, dataset: xr.Dataset) -> xr.Dataset:
    """Runs the registered QualityManagers on the dataset.

    Args:
        dataset (xr.Dataset): The dataset to apply quality checks and controls to.

    Returns:
        xr.Dataset: The quality-checked dataset.

    """
    for manager in self.managers:
        dataset = manager.run(dataset)
    return dataset