ThunderGraph Model Documentation

ThunderGraph Model is an executable systems modeling library for Python.

User Guide

• Install
  • Requirements
  • Install for development (repo workflow)
  • Install as a library
  • Verify install
• Overview
  • Start here
  • Concrete concept examples
  • API reference
• Mental Model
  • Mini walkthrough (same symbol, three layers)
• End-to-End Guide: Building a Complete System
  • What we are building
  • Step 1: Define leaf Parts
  • Step 2: Define Requirement packages
  • Step 3: Compose Requirements into a tree
  • Step 4: Define the System
  • Step 5: Instantiate
  • Step 6: Evaluate
  • Step 7: Read results
  • Complete listing
  • Summary: the authoring loop
  • Where to go next
• Concept: Parts
  • Minimal Part
  • Parameters
  • Attributes
  • Constraints
  • Composing Parts
  • Roll-ups
  • Ports and connections
  • Reference: Part methods
• Concept: Systems
  • Anatomy of a System
  • Scenario parameters on a System
  • Allocation wiring in depth
  • Allocating nested requirement packages
  • Multiple allocations across different Parts
  • Reference: System methods
• Concept: Requirements
  • The authoring pattern
  • Composing requirement packages
  • Mounting requirements on a System
  • Reading constraint results
  • Available methods inside Requirement.define()
• Concept: Evaluation
  • The two evaluation paths
  • Step 1: Instantiate
  • Step 2 (recommended): cm.evaluate
  • Step 2 (explicit): compile_graph + Evaluator
  • Reading RunResult
  • Validation
  • Multiple evaluations on one ConfiguredModel
  • Analysis utilities
• Concept: External Compute (Concrete Binding)
  • Example
  • Input and output contract
  • Rule of thumb
• FAQ
  • Where do I start if I am new?
  • When should I use ConfiguredModel.evaluate vs compile_graph + Evaluator?
  • Why do I need RunContext?
  • Why are inputs bound by stable id in the explicit pipeline?
  • I changed code in a notebook and behavior is weird.
  • When should I use Requirement?
  • How do I split requirements into a hierarchy?
  • When does model.composed_of return a PartRef vs RequirementRef?
  • The graph compiled but evaluate failed or results look wrong.
  • How do I filter constraint results by requirement?
  • The graph compiled but evaluate is very slow.
  • How do I run a parameter sweep?

Quickstart

• Quickstart
  • Install
  • Recommended path: instantiate → evaluate
  • Advanced path: explicit compile_graph + Evaluator
  • Requirements alongside a Part tree
  • What happened (both paths)
  • Next steps

Developer

• Developer architecture
  • Subsystems
  • Pipeline sequences
  • Invariants (mental checklist for contributors)
  • Composable requirement packages
  • Extension points
• Repository map
  • Layout
  • Suggested reading order (new contributor)
• Extension playbook
  • Supported extension surfaces
  • What is not a stable extension API
  • Practical workflow
  • References
• Testing
  • Layout
  • Adding a regression
  • Notebooks
  • Coverage
  • References
• Contributing
  • Before you open a PR
  • Checklist (public behavior changes)
  • Docs build
  • References
• Releasing
  • Version
  • What ships
  • Documentation
  • References
• NumPy-style docstrings for tg_model (Phase 0 contract)
  • Standard
  • What counts as “public”
  • Required sections by symbol kind
  • Style rules
  • PR checklist (touched public API)
  • Pilot reference

API Reference

• API Reference
  • tg_model
  • tg_model.model
  • tg_model.execution
  • tg_model.integrations
  • tg_model.analysis

Drafts

• What ThunderGraph Model Is
  • What It Is Not
  • Core Promise
  • Reader Mental Model
  • Primary Entry Points
  • Why This Matters
• Execution Pipeline (Compile -> Instantiate -> Graph -> Evaluate)
  • 1) Compile types
  • 2) Instantiate a configured topology
  • 2a) Default run path: ConfiguredModel.evaluate (recommended)
  • 3) Compile dependency graph
  • 4) Validate graph (optional but recommended)
  • 5) Evaluate one run (explicit pipeline)
  • Requirement acceptance path
  • Behavioral path
  • One sentence summary
• Glossary
  • Element
  • System
  • Part
  • Requirement
  • ModelDefinitionContext
  • model.name
  • model.doc
  • model.composed_of
  • model.parameter
  • model.attribute
  • model.constraint
  • allocate
  • Ref / PartRef / AttributeRef / RequirementRef
  • compile (type compile)
  • ConfiguredModel
  • ValueSlot
  • RunContext
  • DependencyGraph
  • Evaluator
  • RunResult
  • ConstraintResult
  • ExternalComputeBinding
  • BehaviorTrace
  • Scenario
  • Stable ID
  • ExternalCompute / AsyncExternalCompute
• Repository Map (thundergraph-model)
  • Core package
  • Documentation
  • Examples and notebooks
  • Tests
  • Practical navigation order