Skip to main content

Module model_card

Module model_card 

Source
Expand description

Equation Model Card (EMC) - Mandatory documentation for EDD simulations.

The EMC bridges mathematics and code, ensuring every simulation is grounded in peer-reviewed theory. No simulation can run without a complete EMC.

§EMC Schema (9 Required Sections)

  1. Identity: Name, UUID, version
  2. Governing Equation: LaTeX, analytical derivation
  3. Variables: All parameters with units and constraints
  4. Verification Tests: Analytical solutions for TDD
  5. Domain Constraints: Valid operating ranges
  6. Falsification Criteria: How to disprove the model
  7. References: Peer-reviewed citations
  8. Implementation Notes: Numerical considerations
  9. Lineage: Parent equations, derivations

Re-exports§

pub use super::equation::Citation as EmcCitation;

Structs§

DomainConstraint
Domain constraint specifying valid operating ranges.
EmcBuilder
Builder for EquationModelCard.
EquationModelCard
Equation Model Card - Complete documentation for a governing equation.
FalsificationCriterion
Falsification criterion defining how to disprove the model.
ImplementationNote
Implementation notes for numerical considerations.
VerificationTest
A verification test case with known analytical solution.

Enums§

NoteImportance
Importance level for implementation notes.
ViolationBehavior
Behavior when a domain constraint is violated.