Skip to content

Add CLAUDE.md#46

Closed
hdrake wants to merge 1 commit into
MOM6-community:masterfrom
hdrake:add-claudemd
Closed

Add CLAUDE.md#46
hdrake wants to merge 1 commit into
MOM6-community:masterfrom
hdrake:add-claudemd

Conversation

@hdrake

@hdrake hdrake commented Jun 22, 2026

Copy link
Copy Markdown
Member

Adds a CLAUDE.md to guide Claude Code (and human contributors) working in this repo.

Contents

  • Commands: conda dev setup, running the full test suite and a single test, plus notes on the CI Python matrix, PyPI publish-on-release, and the single-sourced version in version.py.
  • Architecture: the three-stage pipeline — section.py (waypoints → grid corner indices), transports.py (corner indices → U/V velocity faces → convergent_transport), tracers.py (extract_tracer) — plus supporting modules (gridutils.py, utils.py) and project conventions (Q/corner vs. velocity points, grid symmetry/boundary metadata, locally-orthogonal curvilinear grid support, flat re-exported API).

All content is derived from the source, pyproject.toml, README, and CI configs.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
hdrake added a commit to hdrake/sectionate that referenced this pull request Jun 26, 2026
…6-community#46)

Track CLAUDE.md on this branch so the architecture overview lands together with
the code it describes -- corner_position/corner_offset, native 'left'
(MITgcm/ECCO) grids, check_symmetric as a thin wrapper, and the removal of
symmetrize -- rather than in a separate PR that would document code not yet on
its base. Also includes the repo's Definition-of-Done checklist (run the full
test suite, re-execute the example notebooks, and scan for doc/code drift before
committing). Supersedes the standalone add-claudemd PR (MOM6-community#46).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@hdrake

hdrake commented Jun 26, 2026

Copy link
Copy Markdown
Member Author

Superseded by #47 (topology-driven-neighbors), which now introduces CLAUDE.md alongside the code it documents — native 'left' (MITgcm/ECCO) C-grid support, corner_position/corner_offset, and the removal of symmetrize — plus a Definition-of-Done checklist. Keeping the doc and the code it describes in the same PR avoids documenting code that isn't on the base branch. Closing in favor of #47.

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