Skip to content

Commit

Permalink
add docstring for apply_qc_checks
Browse files Browse the repository at this point in the history
  • Loading branch information
Geet-George committed Nov 9, 2023
1 parent 7e3cff6 commit cd83387
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/halodrops/sonde.py
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,25 @@ def qc_check_near_surface_coverage(self, samples_threshold=10):
)

def apply_qc_checks(self, qc_checks):
"""Apply QC checks to the sonde
Parameters
----------
qc_checks : list
List of QC checks to be applied; names must remove the `qc_check_` prefix of the method names
Raises
------
ValueError
If the QC check does not exist.
Attributes Set
--------------
profile_fullness : bool
Return value of qc_check for profile coverage (qc_check_profile_fullness)
near_surface_coverage : bool
Return value of qc_check for near surface coverage (qc_check_near_surface_coverage)
"""
qc_functions = {
"profile_fullness": self.qc_check_profile_fullness,
"near_surface_coverage": self.qc_check_near_surface_coverage,
Expand Down

0 comments on commit cd83387

Please sign in to comment.