Skip to content

Docs fix#65

Closed
tomsail wants to merge 4 commits into
oceanmodeling:mainfrom
tomsail:docs_fix
Closed

Docs fix#65
tomsail wants to merge 4 commits into
oceanmodeling:mainfrom
tomsail:docs_fix

Conversation

@tomsail
Copy link
Copy Markdown
Contributor

@tomsail tomsail commented May 18, 2026

No description provided.

claude and others added 4 commits May 18, 2026 12:08
- mkdocs-material configuration for project documentation
- docs/index.md: landing page with project overview and navigation
- docs/getting-started.md: installation, reading, writing, slicing guide
- docs/api.md: full API reference (dataset structure, attributes, accessor)
- docs/examples/: four practical examples using test data files:
  - 2D tidal flats (bathymetry, water depth, time series)
  - 3D tidal flats (vertical profiles, layer extraction, velocity comparison)
  - 3D bump (elevation, velocity, dynamic pressure)
  - Create from scratch (Delaunay mesh, programmatic dataset construction)
- scripts/generate_plots.py: hvplot/panel export producing 10 standalone
  interactive HTML files embedded via iframes in the documentation
- All HTML plots are self-contained (Bokeh+Panel JS from CDN, data inline)

https://claude.ai/code/session_01XTgheP2NJYo6dNPQc1SEAd
…6vr4l

Claude/enhance docs with examples 6vr4l
@tomsail tomsail closed this May 18, 2026
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.

2 participants