[FEAT] Add report generation#84
Open
eleanorfrajka wants to merge 10 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive pipeline-based processing system to SeaSenseLib along with report generation capabilities. The changes introduce a modular, configurable architecture for Level-1 oceanographic data processing with 7 pipeline stages: mapping, unit handling, derivation, metadata extraction, metadata enrichment, validation, and finalization.
Changes:
- New pipeline system with 7 configurable processing stages
- Report generation functionality (mentioned in title but writer implementation not visible in diff)
- JSON-based knowledge base for parameters, mappings, and conventions
- Updated CF Convention version from 1.8 to 1.13
- Added conservative temperature derivation
- Extensive test coverage for new pipeline components
- CLI enhancements with logging support and pipeline controls
Reviewed changes
Copilot reviewed 151 out of 162 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/* | Comprehensive test suite for pipeline stages, handlers, and utilities |
| seasenselib/pipeline/* | Complete pipeline system implementation with stages and handlers |
| seasenselib/knowledge/* | JSON knowledge base for parameters, mappings, units, and conventions |
| seasenselib/readers/* | Updated readers to support pipeline system and add format_mappings() |
| seasenselib/writers/* | Added logging to writers |
| seasenselib/plotters/* | Lazy matplotlib import optimization |
| seasenselib/parameters.py | Added conservative_temperature and knowledge base loader |
| seasenselib/core/io_manager.py | Added return_metadata support |
| seasenselib/cli/* | Enhanced CLI with logging configuration and lightweight parser mode |
| pyproject.toml | Version bump to 0.5.0, added pint dependency |
| requirements*.txt | Added pint dependency |
| notebooks/demo.ipynb | Added pipeline examples and report generation demo |
| docs/source/index.rst | Added reports section |
Comments suppressed due to low confidence (2)
seasenselib/readers/base.py:204
- This import of module logging is redundant, as it was previously imported on line 17.
seasenselib/writers/base.py:226 - Overridden method signature does not match call, where it is passed too many arguments. Overriding method method ReportWriter.write matches the call.
Overridden method signature does not match call, where it is passed an argument named 'title'. Overriding method method ReportWriter.write matches the call.
Overridden method signature does not match call, where it is passed an argument named 'include_plot'. Overriding method method ReportWriter.write matches the call.
Overridden method signature does not match call, where it is passed an argument named 'plot_output_dir'. Overriding method method ReportWriter.write matches the call.
Overridden method signature does not match call, where it is passed an argument named 'processing_metadata'. Overriding method method ReportWriter.write matches the call.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 is an edit on the other PR, which maybe isn't how I should've added it.
Generates reports as *.rst including information about the variable mapping and basic plots. I haven't tested it yet for mooring data--so the example (also included in the docs) is for a profile with plot.