Deprecation & Legacy Inventory
This inventory highlights modules and documents by stability class.
Legend: - A Active + Public - B Active + Internal - C Legacy (retained for compatibility/old language) - D Dead (safe to remove)
Supported month filtering
cubedynamics.verbs.month_filter is the canonical, warning-free factory.
The former public export accidentally pointed at its own deprecated ops shim.
The implementation now lives in verbs/stats.py; the historical
cubedynamics.ops.transforms.month_filter, cubedynamics.ops.month_filter,
and top-level cubedynamics.month_filter shortcuts retain their warning and
forward to the supported factory. Calendar selection and Dask laziness are
unchanged. No additional public replacement name was introduced.
Code modules
| Path | Class | Evidence | Proposed action |
|---|---|---|---|
src/cubedynamics/__init__.py |
A | Exports public symbols via __all__ and used throughout docs/examples. |
Keep; update exports when public surface changes. |
src/cubedynamics/piping.py |
A | pipe and Pipe referenced in docs (concepts/grammar, quickstart) and tests. |
Keep as core entry point. |
src/cubedynamics/verbs/ |
A | Imported as verbs namespace in README, docs, and examples. It currently combines common vocabulary, integrations, and project verbs. |
Preserve 0.x imports; classify new verbs by ownership and consider later project extraction with deprecations. |
src/cubedynamics/data/{gridmet,prism}.py |
A | Loaders exposed in cubedynamics.__all__ and docs/recipes. |
Keep; treat as public loaders. |
src/cubedynamics/sentinel.py |
A | New Sentinel-2 loaders exposed in __all__; used by docs and pipelines. |
Keep; deprecate older aliases. |
src/cubedynamics/data/sentinel2.py |
C | Older loader names (load_s2_*) still imported but now emit deprecations. |
Keep as warning alias until removal window. |
src/cubedynamics/demo.py, src/cubedynamics/demo_vase.py |
C | Used only in exploratory examples; not referenced in nav or tests. | Move to explicit legacy/demo area or document as non-stable. |
src/cubedynamics/vase_viz.py |
C | Viewer convenience; not exported publicly, superseded by verbs.plot and viz. |
Mark as legacy; consider redirecting users to v.plot. |
src/cubedynamics/ops/*, streaming/*, ops_fire/*, ops_io/*, viewers/*, utils/*, config.py |
B | Imported internally by verbs and pipelines; not documented as public. | Keep internal; document as unstable surface. |
src/cubedynamics/tests/ |
B | Internal test helpers; not part of package exports. | Keep for regression coverage. |
No D-class code confidently identified; uncertain items kept as legacy aliases.
Documentation
| Path | Class | Evidence | Proposed action |
|---|---|---|---|
docs/quickstart.md, docs/concepts/*, docs/verbs/* |
A | Linked in MkDocs nav; use current vocabulary. | Keep as canonical docs. |
docs/vase_volumes.md |
A | Canonical vase guide referenced by legacy stub. | Keep; ensure language matches glossary. |
docs/vase-volumes.md |
C | Legacy path kept for backward compatibility; now stub pointing to canonical page. | Keep stub; leave full content in docs/legacy/. |
docs/legacy/vase-volumes.md |
C | Archived original vase volume write-up. | Keep in legacy folder; omit from nav. |
docs/viewer_debug_notes.md, docs/streaming_renderer.md |
C | Quarantined as deprecated stubs that point at archived notes under docs/legacy/internal_notes/. |
Keep stub paths for backwards links; do not expand as active docs. |
docs/legacy/internal_notes/* |
C | Archived engineering/debug notes retained for traceability only. | Keep out of nav; treat as historical reference. |
docs/examples/*, docs/recipes/* |
B | Supplemental material referenced sporadically. | Keep; audit for vocabulary alignment. |
No D-class docs identified yet; treat ambiguous pages as legacy instead of deleting.
Old-stuff quarantine sweep (2026-03-27)
Completed in this pass:
- Moved standalone debug notes from top-level docs paths into docs/legacy/internal_notes/.
- Replaced the original top-level files with lightweight deprecated stubs so old inbound links still resolve.
Next quarantine candidates (non-breaking, docs-only):
- Root-level historical pages not in nav (docs/pipe_syntax.md, docs/pipe_verbs.md, docs/cubeplot_grammar.md) can follow the same stub + archive pattern.
- Older conceptual snapshots (docs/climate_cubes.md, docs/concepts/climate_cubes.md) can be merged into canonical concepts pages and retained as legacy aliases.
Tests and examples
| Path | Class | Evidence | Proposed action |
|---|---|---|---|
tests/ (root) |
B | Internal regression tests; not shipped to users. | Keep and expand to cover public API. |
docs/vignettes/ |
A | Deterministic offline notebooks, website pages, and CI execution targets. | Keep small and require execution for every publication release. |
notebooks/ |
C | Exploratory and historical content; may need network services, optional renderers, or historical APIs. | Keep labeled as exploratory; promote selected stories into supported vignettes. |
examples/custom_verb_project/ |
A | Tested scaffold for project-owned extension verbs. | Keep aligned with the custom-verb guide and vignette. |
Other examples/ |
C | Exploratory scripts with mixed network and dependency requirements. | Audit individually before promoting to supported vignettes. |
This inventory should be revisited after adding deprecation warnings and redirect stubs to confirm whether any C-class items can be safely removed.