Time-Domain System Equivalent logoTime-Domain System EquivalentLinear dynamics, solved faster.Discuss an evaluation
SDK Documentation

TDSE Runtime

Runtime product scope, reading paths, terminology, and conventions.

Scope

TDSE Runtime is the required core product for every customer. CPU capability is included. GPU and FPGA are optional hardware Add-ons whose build presence, device visibility, authorization, product runtime, and qualification are reported separately.

This manual covers authoring, integration, deployment preparation, target operation, and support from one complete TDSE installation. These are usage scenarios, not products, SKUs, or installation configurations. Builder is the Runtime API and workflow for pack creation; it is not a separate product, library, or package. CLI, Profiler, Telemetry, and plugin integration are technical surfaces delivered around Runtime. TDSE Circuit is a separately purchased domain component with its own user and integration guide.

How To Use This Manual

Follow the shortest path that matches the current task:

Reader goalStart hereContinue with
Evaluate the packageInstallationHands-On Tutorial
Author a Runtime PackBuilder and Data ContractsRuntime Lifecycle
Embed Runtime in a hostRuntime IntegrationStep Execution
Prepare a target deploymentInstallationPlatform Notes
Tune or accelerate RuntimeBackend Selection and PerformanceRuntime Performance Tuning
Diagnose an incidentRuntime Troubleshooting RunbookTroubleshooting
Start from a circuit or RAW caseTDSE Circuit manualthe applicable Integration Playbook (SDK source: docs/integrations/README.md)

For a closed-source evaluation package:

  1. verify the installed package and product identity;
  2. complete one Builder-to-Runtime tutorial;
  3. select the example closest to the intended host;
  4. validate CPU behavior before enabling a hardware Add-on;
  5. qualify the final host target and payload independently.

Book Structure

  • Onboarding: installation, tutorial, examples, and concepts.
  • Authoring: Builder inputs, validation, and Runtime Pack creation.
  • Runtime integration: lifecycle, step order, variable timestep, concurrency, threading, and multi-model use.
  • Hardware and performance: CPU, GPU Add-on, FPGA Add-on, Profiler, Telemetry, backend policy, and tuning.
  • Deployment and operations: platform constraints, plugins, diagnostics, troubleshooting, and acceptance checklists.

Exact declarations belong to the API Reference (SDK source: docs/api-reference/c-api.md). Exact command flags belong to the CLI Reference. Current capability and qualification claims belong to the Runtime Backend Support Matrix (SDK source: docs/user-guide/runtime-backend-support-matrix.md). These references are not additional formal user manuals.

Runtime Flow

Runtime consumes an identified Runtime Pack and participates in a host-owned simulation step:

Validated data -> Builder -> Runtime Pack -> TDSE Runtime -> host trial/commit
  • Builder creates the reusable pack during model preparation.
  • Runtime loads the pack and evaluates the packaged operator.
  • The host owns time, scheduling, acceptance, rollback, and global solving.
  • A partner target uses the supported Redistributable Payload containing the Runtime binary, selected providers, product identity, dependency records, and notices.

TDSE Runtime is not a general-purpose circuit simulator. Customers whose starting point is a circuit netlist, RAW/SEQ case, or Circuit-owned ModelSpace workflow use TDSE Circuit before the Runtime handoff.

Document Conventions

Typographic conventions used throughout this guide:

ConventionMeaningExample
BoldEmphasis, important terms on first useThe Runtime executes the pack
ItalicNew terms, parameter names in prosethe runtime pack is read-only
MonospaceCode, API symbols, file paths, command-line inputcall tdse_model_create()
Monospace boldCommands to type exactly as showncmake --build build --parallel 4

The guide uses four callout styles. Each appears here exactly as it does in the rest of the book:

WARNING: Critical information that prevents data loss or incorrect results.

IMPORTANT: Information essential to correct usage.

NOTE: Supplementary information or clarification.

TIP: Shortcut or recommended practice.

Key Terminology

The terminology below covers the technical abbreviations and runtime terms used most often in the handbook.

Core Terms

TermMeaning
HImpulse Response - Time-domain impulse response (delayed-history operator)
IRIndependent Response - Pre-computed independent response sequence (optional)
opInstantaneous Operator - Immediate response term (G0 or R0) at current timestep
hrHistory Response - Delayed-history contribution from past timesteps
irIndependent Response Term - Contribution from pre-computed IR sequence
drDirect Response - Post-commit direct response term
BuilderTDSE Runtime API and workflow that creates runtime packs from validated input data; not a separate product or library
RuntimeRequired core product and execution engine for runtime packs
packRuntime Pack - Compressed binary model file created by Builder
trial stepCurrent not-yet-committed evaluation context created by tdse_step_begin(...)
committed stepLast accepted step after tdse_step_commit(...)
portInterface variable pair defining coupling between linear and nonlinear subsystems
impulse responseTime-domain response of the linear subsystem to a unit impulse at a port

Lifecycle Terms

TermMeaning
closeExplicit shutdown request that returns immediately with a status
destroyRecommended shutdown call with a caller-chosen wait budget
releaseFinal cleanup path, usually used in RAII or finally-style code
ownership handoffMoment a caller must stop treating a handle as locally owned
bounded destroyDestroy with an explicit wait budget and a result the caller can inspect

Diagnostics Terms

TermMeaning
create diagnosticsRequest-scoped data returned through tdse_model_create_diagnostics_t
model infoStatic metadata snapshot for a live handle
state infoDynamic execution-state snapshot for a live handle
last error infoSticky snapshot of the most recent non-OK runtime result
pack error tokenSymbolic name derived from create_diag.pack_error_code

Concurrency Terms

TermMeaning
same-handle concurrent useOverlapping runtime API entry on the same tdse_model_t*
execution threadLogical worker or simulation thread that owns one runtime handle
finalizer cleanupCleanup path that does not itself define host lifecycle policy

Revision History

VersionDateDescription
1.0.0-rc12026-08-15Current release candidate; see the repository changelog for release history and later unreleased contract changes.