MADDENING

Modular Automatic Differentiation and Data Enhanced Neural-network INteracting Graph — a pure-JAX, autodifferentiable framework for composing physical models from typed nodes connected by unit-aware edges. MADDENING is the base framework on which MIME and the MICROROBOTICA IDE are built.

User Guide

• Installation
  • Base Install
  • GPU Acceleration
  • Feature Extras
  • Cloud Deployment
  • Task Bundles
  • Everything
  • Using uv
  • Verifying Your Installation
  • Missing Dependency Errors
• Quickstart
  • Install
  • Your First Simulation
  • Coupled Simulation
  • Differentiable Everything
  • Deploy to Cloud
  • Next Steps

Algorithm Guide

• [Node Name]
  • Summary
  • Governing Equations
  • Discretization
  • Implementation Mapping
  • Assumptions and Simplifications
  • Validated Physical Regimes
  • Known Limitations and Failure Modes
  • Stability Conditions
  • State Variables
  • Parameters
  • Boundary Inputs
  • References
  • Verification Evidence
  • Changelog
• HeatNode
  • Summary
  • Governing Equations
  • Discretization
  • Implementation Mapping
  • Assumptions and Simplifications
  • Validated Physical Regimes
  • Known Limitations and Failure Modes
  • Stability Conditions
  • State Variables
  • Parameters
  • Boundary Inputs
  • References
  • Verification Evidence
  • Changelog
• Unit-Aware Edge Transforms
  • Overview
  • Unit Annotations
  • LBM Lattice Unit Conversions
  • MIME Follow-on
• Uncertainty Quantification Roadmap
  • Current Status
  • UQ Interface
  • V&V 40 Capability Mapping
  • Future Work

Developer Guide

• Node Authoring Guide
  • The Contract
  • Directory Structure
  • Step-by-Step
  • Boundary Input Specification
  • Exposing Flux Quantities
  • Additive vs Replacive Inputs
  • Coupling Patterns
  • Transform Registration
  • New Node Checklist
• Testing Standards
  • 1. Unit Tests (mandatory for all code)
  • 2. Integration Tests (mandatory for nodes)
  • 3. Verification Benchmarks (mandatory for physics nodes)
  • Running Tests
  • Environment Variables
  • Test Organization
  • pytest Configuration
• Documentation Standards
  • Docstring Format
  • Math in Code
  • Bibliography
  • Algorithm Guide Documents
  • Implementation Mapping
  • Commit Message Convention
  • CHANGELOG.md
  • Anomaly Registry
  • Versioning

Validation

• Context of Use (COU) Template
  • 1. Question of Interest
  • 2. Quantities of Interest (QOIs)
  • 3. Model Influence
  • 4. Decision Consequence
  • 5. Risk Assessment
  • 6. Credibility Goals
  • 7. Evidence Plan
• Framework Verification Summary
  • Overview
  • Test Suite
  • Test Organization
  • Registered Verification Benchmarks
• MADDENING SOUP Package Document
  • 1. Software Identification
  • 2. Functional Description
  • 3. Known Anomalies
  • 4. Verification Evidence
  • 5. IEC 62304 Lifecycle Activities
  • 6. Configuration Management
  • 7. Anomaly Management Policy
  • 8. Dependencies

Regulatory

• MADDENING — Intended Use and Regulatory Positioning
  • Platform Positioning Statement
  • Layered Responsibility Model
  • Commercial Boundary Statement
  • Cybersecurity Boundary Statement (MDCG 2019-16)
  • LGPL Replaceability Statement
• IEC 62304 Software Lifecycle Documentation Mapping
  • Scope
  • Mapping
• EU MDR Alignment Guide
  • Scope
  • Annex I — General Safety and Performance Requirements (GSPRs)
  • Annex II — Technical Documentation
  • MDCG 2019-16 — Cybersecurity
• MDCG 2019-11 — Qualification and Classification Analysis
  • Step 1: Is MADDENING a Medical Device?
  • Step 2: How Would a Downstream Product Be Classified?
  • IMDRF SaMD Risk Framework Alignment
• Downstream Integration — Dependency Chain and Responsibilities
  • Four-Layer Dependency Chain
  • Per-Layer Responsibility Details
  • Commercial Responsibility Statement
  • Classification-by-Use-Mode Analysis
  • Commercial Boundary Documentation