Documentation
Build, validate, and ship simulations
with an engineering agent.
SimPilot is a chat-first agent for physics simulations. These docs cover the kernel, typed case state, governed compute, solver packs, validation evidence, studies, and reporting — accurate to the current codebase.
40 docs · 8 sections · press ⌘K from anywhere
Start here
IntroductionSimPilot is a chat-first engineering agent for physics simulations. Tell it what to model; it plans, sets up, runs, validates, and reports with evidence.
First case
QuickstartRun your first case end-to-end. Open chat, describe the problem, approve the launch, inspect evidence, and publish a report.
Concepts
The Agent RuntimeHow SimPilot acts like an engineering agent: phases, typed events, tools, approvals, subagents, and replay.
Trust
Evidence & ReportsHow residuals, QoIs, figures, artifacts, citations, and review records compose into an audit-ready report.
What you get
One kernel. Three commitments.
Describe the engineering outcome in plain language. The agent plans, sets up, runs, and validates.
OpenFOAM, SU2, and CalculiX plug into the same typed CaseSpec, validators, and report pipeline.
Every claim points at a run record, parser output, citation, or artifact hash. Replay is durable.
Explore the docs
Pick a track.
Getting Started
Land in the chat-first workspace and ship a real case in minutes.
SimPilot is a chat-first engineering agent for physics simulations. Tell it what to model; it plans, sets up, runs, validates, and reports with evidence.
Run your first case end-to-end. Open chat, describe the problem, approve the launch, inspect evidence, and publish a report.
The five-object mental model behind every SimPilot session. Learn what each one owns and how they compose.
A guided tutorial: from an empty workspace to a published engineering report, with every approval and evidence trail explained.
How the first-run walkthrough uses a live agent in review-first mode, and what typed signals advance each step.
Core Concepts
The agent kernel, typed case state, and the contracts behind every run.
The shape of the SimPilot platform: one agent kernel, a typed protocol, governed compute, and durable rollout records.
How SimPilot acts like an engineering agent: phases, typed events, tools, approvals, subagents, and replay.
Every case moves through 23 typed lifecycle steps, each with a Gate, Acceptance, Invalidation contract. This is how the agent stays disciplined.
The CaseSpec is the simulation contract. Everything else — solver files, runs, figures, reports — is derived.
How SimPilot treats file access and shell commands as governed engineering primitives, not escape hatches.
Durable, classification-aware memory that lets the agent learn across cases without leaking context across tenants.
Workflows
Step-by-step recipes for authoring, running, diagnosing, and reporting.
Practical guidance for steering the agent from chat: writing prompts, reviewing plans, asking for changes, and handing off context.
How to compose, edit, and refine a CaseSpec — directly in chat, through the case editor, or from a template.
Launching a run, tailing live monitors, pausing, resuming, and reading the typed run record.
When materialization, meshing, or solving fails, how to find the real root cause without overfitting to the error message.
Run parameter sweeps, mesh-refinement studies, time-step studies, and design comparisons under a single typed plan.
Generate, review, and share replayable reports. Choose audience profiles, apply standards packs, and publish with provenance.
Solvers & Authoring
Solver packs, templates, standards packs, and figure roles.
The shared contract that lets OpenFOAM, SU2, and CalculiX plug into the same agent, validation, and reporting pipeline.
File-native CFD with full dictionary generation, function-object hooks, and benchmark-grade validation paths.
Config-and-mesh-driven CFD for aerodynamic, incompressible, compressible, thermal, and elasticity workflows.
Input-deck FEA for linear and nonlinear structural, thermal, and thermomechanical cases.
Author report policy as typed standards packs so docs, help, validation, and report generation never drift.
Bind figure roles to solver fields, viewpoints, and renderers so the viewer, docs, and report agree.
Templates accelerate common cases; skills capture method. Both are signed, both are optional — neither replaces the kernel.
Validation & Studies
Evidence, residuals, QoIs, mesh studies, verification, and review.
How residuals, QoIs, figures, artifacts, citations, and review records compose into an audit-ready report.
Two contracts that gate every credible run: the QoI extraction recipe and the mesh-quality bar.
Solution verification, mesh convergence, sensitivity / UQ, and the disjointness invariant between calibration and validation.
How a finished case becomes durable, citable knowledge for future runs — with typed applicability bounds and cross-case invalidation.
Operations
Compute plane, jobs, observability, multi-tenancy, and security.
Where solvers actually run: AWS Batch in production, Docker locally, identical workspace and evidence contracts.
The maintenance catalog that keeps rollouts compact, viz pools fresh, OAuth tokens current, and usage rolled up.
Langfuse turn scoring, Sentry breadcrumbs, OpenTelemetry attributes, provider canaries, and ops incident findings.
Org / tenant isolation, admin actions, review workflows, and BYOK encryption for regulated workloads.
Eight named trust boundaries, four data classifications, deny-by-default egress, and the declassifier projection contract.
Resources & Help
Knowledge, skills, local resources, and the in-product help drawer.
Reference
Typed schemas, CLI, environment, and decision records.
Field-by-field reference for the typed case contract every solver pack materializes from.
The typed shape that gates every file write, command, share, and destructive action.
The durable typed event stream behind every chat turn — exportable as Harmony or raw Codex JSONL for inspection.
The simpilot CLI surface and the environment variables the platform reads.
Every architectural decision the platform commits to lives in `docs/adr/` — this index summarizes what each one decides.