Skip to content

Docs theory code mapping#16

Merged
sergioald merged 2 commits into
mainfrom
docs-theory-code-mapping
Jul 9, 2026
Merged

Docs theory code mapping#16
sergioald merged 2 commits into
mainfrom
docs-theory-code-mapping

Conversation

@sergioald

Copy link
Copy Markdown
Owner

Summary

Adds docs-only theory/code and validation mapping material.

Added

  • docs/theory_code_mapping.md

    • Maps model concepts to implementation modules/functions.
    • Documents the main runtime call graph.
    • Clarifies default free-boundary and NumPy pathways.
    • Summarises output and testing maps.
  • docs/validation_strategy.md

    • Summarises current validation philosophy.
    • Lists validated behaviours and known limitations.
    • Records recommended wording around periodic flow, optional Numba, and stability diagnostics.
    • Provides a validation roadmap and review checklist.
  • README links to the new docs.

Validation

python -m pytest

@sergioald
sergioald merged commit 056c310 into main Jul 9, 2026
3 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.

1 participant