|
| 1 | +# CLAUDE.md |
| 2 | + |
| 3 | +This file provides guidance to Claude Code when working in this monorepo. |
| 4 | + |
| 5 | +## Project |
| 6 | + |
| 7 | +`gds-core` — monorepo for the Generalized Dynamical Systems ecosystem. Contains four packages managed as a uv workspace. |
| 8 | + |
| 9 | +## Packages |
| 10 | + |
| 11 | +| Package | Import | Location | |
| 12 | +|---------|--------|----------| |
| 13 | +| gds-framework | `gds` | `packages/gds-framework/` | |
| 14 | +| gds-viz | `gds_viz` | `packages/gds-viz/` | |
| 15 | +| gds-games | `ogs` | `packages/gds-games/` | |
| 16 | +| gds-examples | — | `packages/gds-examples/` | |
| 17 | + |
| 18 | +## Commands |
| 19 | + |
| 20 | +```bash |
| 21 | +# Install all packages (workspace-linked) |
| 22 | +uv sync --all-packages |
| 23 | + |
| 24 | +# Run tests per-package |
| 25 | +uv run --package gds-framework pytest packages/gds-framework/tests -v |
| 26 | +uv run --package gds-viz pytest packages/gds-viz/tests -v |
| 27 | +uv run --package gds-games pytest packages/gds-games/tests -v |
| 28 | +uv run --package gds-examples pytest packages/gds-examples -v |
| 29 | + |
| 30 | +# Run all tests |
| 31 | +uv run --package gds-framework pytest packages/gds-framework/tests packages/gds-viz/tests packages/gds-games/tests packages/gds-examples -v |
| 32 | + |
| 33 | +# Lint & format |
| 34 | +uv run ruff check packages/ |
| 35 | +uv run ruff format --check packages/ |
| 36 | + |
| 37 | +# Build a specific package |
| 38 | +uv build --package gds-framework |
| 39 | + |
| 40 | +# Docs |
| 41 | +uv sync --all-packages --group docs |
| 42 | +uv run mkdocs build --strict |
| 43 | +uv run mkdocs serve |
| 44 | +``` |
| 45 | + |
| 46 | +## Architecture |
| 47 | + |
| 48 | +This is a **uv workspace** monorepo. The root `pyproject.toml` declares `packages/*` as workspace members. Each package has its own `pyproject.toml` with package-specific dependencies and build config. Shared tooling (ruff, docs) is configured at the root. |
| 49 | + |
| 50 | +### Dependency Graph |
| 51 | + |
| 52 | +``` |
| 53 | +gds-framework ← core engine (no GDS dependencies) |
| 54 | + ↑ |
| 55 | +gds-viz ← visualization (depends on gds-framework) |
| 56 | +gds-games ← game theory DSL (depends on gds-framework) |
| 57 | + ↑ |
| 58 | +gds-examples ← tutorials (depends on gds-framework + gds-viz) |
| 59 | +``` |
| 60 | + |
| 61 | +### Key Conventions |
| 62 | + |
| 63 | +- All data models are Pydantic v2 BaseModel |
| 64 | +- Absolute imports only (never relative) |
| 65 | +- Ruff config inherited from root (line-length 88) |
| 66 | +- Each package published independently to PyPI via tag-based workflow (`gds-framework/v0.3.1`) |
| 67 | +- Per-package CLAUDE.md files contain package-specific architecture details |
0 commit comments