Skip to content

1 feature initial oceanosse workflow skeleton#19

Merged
oj-tooth merged 12 commits into
mainfrom
1-feature-initial-oceanosse-workflow-skeleton
Jun 16, 2026
Merged

1 feature initial oceanosse workflow skeleton#19
oj-tooth merged 12 commits into
mainfrom
1-feature-initial-oceanosse-workflow-skeleton

Conversation

@oj-tooth

Copy link
Copy Markdown
Contributor

Skeleton OceanOSSE End-to-End Workflow

Milestone: M0 - Foundation Infrastructure

Summary

  • Establish the structural skeleton of the OceanOSSE package by implementing a minimal, pass-through end-to-end workflow.
  • All core modules and abstract base classes are scaffolded and assembled together in pipeline.py and can be executed using OceanOSSE CLI (cli.py.
  • Basic Test: Example ocean model outputs stored in a netCDF input file should be able to traverse the entire OceanOSSE pipeline and be re-written to a netCDF output file.
  • No actual transformation applied at any stage (i.e., identity transformations implemented).
  • Purpose is to establish initial module interfaces and orchestration logic before any scientific functionality is implemented.

Scope

Following components should be stubbed and connected:

  • cli.py — add a run command that accepts a .toml config path, optional log file path and invokes the pipeline.
  • pipeline.pyrun and describe functions that instantiate and sequences all functions in order.
  • io/reader.py — functions to opens a netCDF file and returns xarray.Dataset.
  • sampling/base.pyObsBaseSampler ABC with a sample(dataset) method that returns the dataset unchanged.
  • error/base.pyInstrumentBaseError ABC with an apply(dataset) method that returns the dataset unchanged.
  • gridding/base.pyObsBaseRegridder ABC with a grid(dataset) method that returns the dataset unchanged.
  • io/writer.py — functions to write the dataset to a netCDF output file.
  • config/validation.py — a minimal pydantic .toml schema covering input path, output path, and placeholder sections for each module.

@oj-tooth oj-tooth self-assigned this Jun 16, 2026
@oj-tooth oj-tooth added tests Improvements to unit / integration testing mod:cli Relates to cli.py module. labels Jun 16, 2026
@oj-tooth oj-tooth linked an issue Jun 16, 2026 that may be closed by this pull request
@oj-tooth oj-tooth added mod: pipeline Relates to pipeline.py module. mod: error Relates to instrument error modules. mod: regridder Relates to regridding modules. mod: utils Relates to I/O or utility modules. priority: high High priority task. labels Jun 16, 2026
@oj-tooth oj-tooth merged commit 8f3dbb2 into main Jun 16, 2026
1 check passed
@oj-tooth oj-tooth deleted the 1-feature-initial-oceanosse-workflow-skeleton branch June 16, 2026 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mod:cli Relates to cli.py module. mod: error Relates to instrument error modules. mod: pipeline Relates to pipeline.py module. mod: regridder Relates to regridding modules. mod: utils Relates to I/O or utility modules. priority: high High priority task. tests Improvements to unit / integration testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[feature] Initial OceanOSSE workflow skeleton.

1 participant