Skip to content

Add zensical documentation#66

Merged
tomsail merged 5 commits into
oceanmodeling:mainfrom
tomsail:main
May 18, 2026
Merged

Add zensical documentation#66
tomsail merged 5 commits into
oceanmodeling:mainfrom
tomsail:main

Conversation

@tomsail
Copy link
Copy Markdown
Contributor

@tomsail tomsail commented May 18, 2026

No description provided.

claude and others added 5 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 linked an issue May 18, 2026 that may be closed by this pull request
@tomsail
Copy link
Copy Markdown
Contributor Author

tomsail commented May 18, 2026

The CI runs were failing because of the numpy version being too low.
Therefore I had to bump up the python version to 3.11

Hence why I bumped the project version to 0.2.1.
Publishing the new version to pipy and conda.

@tomsail tomsail merged commit 01d7ab9 into oceanmodeling:main May 18, 2026
4 checks passed
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.

add docs

2 participants