Repository navigation
[FIX] Check QC overrides in the mooring description; CLI and docs sweep - #123
Merged
Merged
Conversation
eleanorfrajka
marked this pull request as ready for review
November 5, 2026 06:20
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.
Summary
A mistyped QC-override block in the mooring description was silently ignored, so a mooring could run with the default thresholds while the YAML said otherwise.
validate(andmooring.load) now check the four QC blocks. Docs also updated to bring the command-line help and the documentation up-to-date with current behaviour.What's changed
qc_ranges,qc_spike,qc_flat_lineandtilt_qcare checked at mooring and instrument level: a shape mistake (unknown field, a span that is not two increasing numbers, a negative threshold, a new variable with nofail_span) is an ERROR; an unknown variable is a WARNING.sea_water_velocity_to_direction(was the deprecateddirection_of_sea_water_velocity).Examples:.stamp --declare N,export --force,process --summary,plot --downsample-seconds.validatetakes a path, folder or name like the other commands, and gains--strict.ERROR:on stderr; a--proc-dirmooring folder that does not exist is named.python -m oceanarray;-vafter the subcommand;export -n.platform_code,deployment_codeanddata_mode; the OceanSITES export page moves to the user pages with how to run it; wrong claims fixed (stack dimension order, module paths, tilt defaults, flat-line test, folder/name mismatch is a warning); roadmap, quickstart, README, CONTRIBUTING and style guide updated.Breaking changes
mooring.loadandvalidate(it was ignored).standard_nameofcurrent_directionchanges as above.Tests
export --dry-run, exit code 2 on usage errors. Full suite and docs build green.