qa/qc APIs and utilities - #10
Open
joefutrelle wants to merge 3 commits into
Open
Conversation
Collaborator
Author
|
Note that we'll need to resolve the conflict over version number by having this be a 0.4.0 release (since it contains a new feature) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a major new quality control (QC) subsystem to the
ifcbkitlibrary, providing comprehensive integrity checks for IFCB data and products. It also adds a command-line interface (ifcbkit-qc), improves ADC/header parsing, and exposes new APIs for working with ADC files and corrections. The changes include new documentation, new exports in the main package, and a minor version bump to0.3.0.The most important changes are:
Quality Control Subsystem:
Adds the
ifcbkit.qcmodule, which provides functions likecheck_bin,check_collection,check_fileset, andcheck_productsto report whether data is intact (present, parseable, internally consistent) and not whether it is scientifically "good". The QC system distinguishes between errors, warnings, and info-level findings, and supports opt-in checks, cost levels, and detailed reporting. A new CLI tool,ifcbkit-qc, is included for running QC from the command line. [1] [2] [3]The QC system reports on ADC corrections, product coverage, and missing/optional files, and is fully documented in the expanded
README.md. [1] [2]ADC and Header Parsing Improvements:
Adds diagnostic reporting to ADC parsing via an optional
diagnosticschannel initer_adc_targets, allowing consumers to see why lines were skipped (e.g., blank, short, unparseable, zero geometry). Introduces new constants for skip reasons and improves error handling in header parsing (parse failures are now reported, not raised). [1] [2] [3]Exposes new utility functions:
columns_for_bin_id,columns_from_declaration, andparse_adc_file_formatfor working with ADC file formats and column layouts. [1] [2]ADC Correction File Handling:
adcmod_patha public API and ensures that ADC correction files are resolved consistently in both sync and async code paths. QC now reports on corrections (e.g., deltas, orphans, invalid corrections) instead of silently preferring them. [1] [2] [3]Package and CLI Updates:
0.3.0and registers theifcbkit-qcCLI inpyproject.toml. Addsh5pyas an optional dependency for class-score QC. [1] [2] [3]Documentation:
README.mdwith detailed documentation and usage examples for the new QC system, CLI, and product directory conventions. [1] [2]These changes lay the foundation for robust, transparent data integrity checking in IFCB workflows and make the library more extensible and user-friendly for both programmatic and command-line use.