SDK Documentation
HTML-first product documentation generated from the TDSE SDK user guide source.
TDSE SDK is for teams that want to place reusable subsystem dynamics inside an existing simulator, not replace the simulator around it.
This documentation is generated from the canonical SDK guide source in the SDK repository. Start with product boundary and integration shape, then go deeper only where your workflow actually needs detail.
Why TDSE exists, how the method is partitioned, and which modeling assumptions shape integration choices.
SetupInstallationSystem requirements, package layout, setup, verification, and first troubleshooting steps.
Integration PathBuilder and Data ContractsBuilder inputs, data contracts, pack creation, and the main integration flow.
Read By Decision
Evaluating fit
Read Theory and Concepts first, then Builder and Data Contracts.
This path is for platform owners, solver teams, and technical reviewers deciding whether TDSE fits an existing simulator architecture and ownership model.
Bringing up an integration
Read Installation, then Getting Started, then Lifecycle and Ownership.
This is the shortest path to a real Builder-to-Runtime bring-up.
Starting from circuit inputs
Read Adapter Circuit first, then keep Element Reference nearby while validating supported elements and source behavior.
Source And Ownership
These web docs are generated from the SDK repository rather than maintained as a second hand-edited website copy.
- Manifest:
docs/books/tdse_sdk_user_guide.json - Chapter source:
docs/user-guide/*.md - SDK revision at generation time:
9c50c96c
Reference Surface
- Backend Selection and Performance: Backend selection, runtime plans, CUDA, precision, thread control, and benchmark guidance.
- CLI Reference: Unified
tdsecommand surface, output artifacts, and exit-code behavior. - Troubleshooting: Diagnostic surfaces, failure modes, and the evidence to collect before escalation.
- Telemetry: Telemetry lifecycle, event reference, exporters, deployment, and runtime observability.
- Platform Notes: Linux support scope, WSL workflow, and current platform boundaries.
- Appendix: Final integration checklist, worked example material, platform notes, and real-time deployment guidance.
Move through the docs by the problem in front of you.
- Evaluating fit: Theory and Concepts -> Builder and Data Contracts
- Bringing up integration: Installation -> Getting Started -> Lifecycle and Ownership
- Starting from domain inputs: Adapter Circuit -> Element Reference
Use the PDF when one file is operationally easier.
The generated PDF still exists for review packets, offline reading, and distribution, but it no longer needs to carry the primary web reading experience.
Download PDF