Skip to content

Add documentation, trained models, and examples#167

Merged
taddyb merged 4 commits intoDeepGroundwater:masterfrom
taddyb:operations
Mar 14, 2026
Merged

Add documentation, trained models, and examples#167
taddyb merged 4 commits intoDeepGroundwater:masterfrom
taddyb:operations

Conversation

@taddyb
Copy link
Collaborator

@taddyb taddyb commented Mar 14, 2026

Summary

  • Documentation overhaul: Updated README, startup guide, usage docs, datasets docs, and added a config reference guide and CONTRIBUTING.md
  • Trained model weights: Added v0.5.2 trained weights for both MERIT and Lynker Hydrofabric datasets with example configs and parameter map notebooks
  • Project tooling: Added CLAUDE.md for AI-agent context, CLI entry point (ddr/cli.py), config docs generator script, and updated .gitignore/pyproject.toml

Test plan

  • Verify documentation renders correctly on MkDocs
  • Confirm example configs and notebooks run with the provided trained weights
  • Check that scripts/gen_config_docs.py generates valid config reference output
  • Validate CLI entry point (ddr/cli.py) works as expected

🤖 Generated with Claude Code

@taddyb taddyb merged commit 8489708 into DeepGroundwater:master Mar 14, 2026
4 checks passed
@taddyb taddyb deleted the operations branch March 14, 2026 20:51
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