Skip to content

feat: add underway dataset type, data_accessibility field, align box format with SOSO#28

Merged
clevinson merged 5 commits into
mainfrom
feat/dataset-accessibility-underway-and-box-format
Apr 10, 2026
Merged

feat: add underway dataset type, data_accessibility field, align box format with SOSO#28
clevinson merged 5 commits into
mainfrom
feat/dataset-accessibility-underway-and-box-format

Conversation

@clevinson

Copy link
Copy Markdown
Collaborator

Summary

Addresses three issues from submarine-mrv/oae-data-commons:

  • #97 — Adds underway to the DatasetType enum for data collected continuously from a moving platform (e.g., ship underway system).
  • #99 — Adds a new DataAccessibility enum (open_access, conditional_access, scheduled_access) and a required data_accessibility slot on the base Dataset class. Field-level description enumerates all three options for tooltip rendering in the form; per-value descriptions remain on the enum for downstream consumers.
  • #88 — Aligns the GeoShape.box format with science-on-schema.org. SOSO specifies "<minLat> <minLon> <maxLat> <maxLon>" (latitude-first). The protocol's spatial_coverage and box descriptions previously documented a longitude-first ordering, contradicting SOSO and causing the lat/lon flip reported in the bug. Rewrites box format docs in core.yaml, experiment.yaml, model.yaml; flips example box strings in metadata-format.md to lat-first; cites SOSO guide URL.

Also includes a housekeeping commit regenerating the stale validation.schema.json (was missing classes like CO2Equilibrator that already exist in the source YAMLs).

Doc audit

  • vocabularies.md — added underway and DataAccessibility rows
  • Datasets/index.md — added data_accessibility to key fields table
  • metadata-format.md — flipped box examples to lat-first

Test plan

  • make gen-project && make gen-validation-schema clean
  • make lint passes
  • Verify generated JSON Schema includes DataAccessibility enum, data_accessibility required on Dataset/FieldDataset/ModelOutputDataset, underway in DatasetType
  • Follow-up PR in oae-form to pull schema (make schema), wire data_accessibility into uiSchema, and flip box parser/formatter to lat-first

Refs: submarine-mrv/oae-data-commons#97 submarine-mrv/oae-data-commons#99 submarine-mrv/oae-data-commons#88

🤖 Generated with Claude Code

clevinson and others added 2 commits April 9, 2026 18:11
…quilibrator etc.)

oae_data_protocol.validation.schema.json on main was stale relative to
the source YAMLs — it was missing several classes that exist in
src/oae_data_protocol/schema/ (e.g. CO2Equilibrator from instrument.yaml,
ContinuousCO2Calibration, and related discriminated-union variants).
Someone merged YAML changes without running make gen-validation-schema.

Running the generator against the current YAMLs with the pinned linkml
toolchain (linkml 1.8.7 / linkml-runtime 1.8.3 per poetry.lock) produces
this diff: adds 1229 lines of legitimate missing content, no removals.

Also bumps the generation timestamp in datamodel/oae_data_protocol.py
by 1 line as a side effect.

No schema meaning changes — main's oae_data_protocol.schema.json is
already up to date, so this only touches validation.schema.json and
the datamodel timestamp.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…format with SOSO

Three issues from oae-data-commons:

#97 — Add 'underway' to DatasetType enum, for data collected continuously
from a moving platform (e.g., ship underway system sampling surface
seawater during transit).

#99 — Add new DataAccessibility enum (open_access, conditional_access,
scheduled_access) and a required data_accessibility slot on the base
Dataset class. Field-level description enumerates all three options so
the form can surface them via a single tooltip; per-value descriptions
remain on the enum for downstream consumers.

#88 — Align the GeoShape box format with science-on-schema.org. SOSO
specifies the box string as two space-separated corner points — the
southwest (lower-left) corner followed by the northeast (upper-right)
corner — with each point written as `<latitude> <longitude>` in decimal
degrees: "<minLat> <minLon> <maxLat> <maxLon>". The protocol's
spatial_coverage and GeoShape.box descriptions previously documented a
longitude-first ordering, which contradicted SOSO and was the root
cause of the lat/lon flip reported in jstorylong's bug. This commit
rewrites the box format documentation in core.yaml, experiment.yaml,
and model.yaml; updates example box strings in
src/docs/files/metadata-format.md to lat-first; and cites the SOSO
guide URL.

Doc audit (per CLAUDE.md):
- src/docs/files/vocabularies.md — added underway and DataAccessibility rows
- src/docs/files/Datasets/index.md — added data_accessibility to key fields table
- src/docs/files/metadata-format.md — flipped box example to lat-first

Refs: submarine-mrv/oae-data-commons#97 #99 #88

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Apr 10, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://submarine-mrv.github.io/oae-data-protocol/pr-preview/pr-28/

Built to branch gh-pages at 2026-04-10 03:12 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Comment thread project/jsonschema/oae_data_protocol.schema.json Outdated
clevinson and others added 3 commits April 9, 2026 19:57
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
… GeoShape.box only

The serialization format (lat-first, SOSO spec, example, link) now
lives only on the GeoShape.box attribute description. The spatial_coverage
slot descriptions on Project, Experiment, and ModelGrid just describe
what the field represents. The nested GeoShape.box description propagates
through the schema and is visible to both UI tooltips and LLM consumers.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@clevinson clevinson merged commit 9a8b983 into main Apr 10, 2026
3 checks passed
@clevinson clevinson deleted the feat/dataset-accessibility-underway-and-box-format branch April 10, 2026 03:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant