Skip to content

Conversation

@ecomodeller
Copy link
Member

@ecomodeller ecomodeller commented Jan 18, 2026

Adds Architecture Decision Records (ADRs) to document key architectural decisions, similar to the approach recently added to mikeio (#889).

The ADRs document 9 historical decisions in chronological order:

  1. mikeio as core dependency
  2. Centralized metrics module
  3. Comparer pattern
  4. xarray as internal data structure
  5. Model result type hierarchy
  6. Dual plotting backends
  7. Four-step workflow pattern
  8. Options and styling system
  9. Factory pattern for type detection
  10. Optional dependencies

Document key architectural decisions in /adr directory and update CLAUDE.md to reference them.
Document decision (Draft) for making mikeio1d and future domain-specific dependencies optional rather than required.
Copy link
Member

@jsmariegaard jsmariegaard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love this! I read through it all and agree. Great job

@ecomodeller ecomodeller merged commit 5936a05 into main Jan 19, 2026
2 checks passed
@ecomodeller ecomodeller deleted the adr-documentation branch January 19, 2026 16:07
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.

3 participants