2.1.2. rainfallqc.qc_frameworks package

2.1.2.1. Submodules

2.1.2.2. rainfallqc.qc_frameworks.apply_qc_framework module

Methods to apply QC qc_frameworks to apply to rainfall data to create quality controlled data.

rainfallqc.qc_frameworks.apply_qc_framework.run_qc_framework(data: DataFrame, qc_framework: str, qc_methods_to_run: list, qc_kwargs: dict, user_defined_framework: dict = None) → DataFrame

Run QC methods from a QC framework.

Parameters:

data

Rainfall data to QC.

qc_framework

QC framework to run, can be ‘in-built’ type i.e. IntenseQC or pyPWSQC or ‘custom’ for user-defined.

qc_methods_to_run

Which methods should be run within that framework i.e. [QC1, QC2]

qc_kwargs

Keyword arguments to pass to QC framework methods.

user_defined_framework

A user-defined QC framework dictionary, required if qc_framework is ‘custom’.

Returns:

qc_results

Results of running QC framework.

2.1.2.3. rainfallqc.qc_frameworks.inbuilt_qc_frameworks module

In-built QC frameworks to apply to rainfall data to create quality controlled data.

rainfallqc.qc_frameworks.inbuilt_qc_frameworks.get_qc_name_from_qc_key(qc_key: str) → str

Return the name of a QC check.

Parameters:

qc_key:

QC check ID

Returns:

qc_name:

QC check name

2.1.2.4. Module contents

Rulebases to apply quality control checks.