Skip to content

Supported interfaces

A project has three authored documents: mission, spacecraft and study. The study connects the other two, selects scenarios and execution options, and names output settings. Validate the complete project before running it; a schema-valid single document is not sufficient to establish cross-document consistency.

Find a field

The contract field reference provides field types, required/optional status, declared defaults, constraints and selected explanations. Each page includes a downloadable JSON schema and its content digest. A missing default, a value of null and a numerical zero have different meanings.

Names in the JSON contract are data-format identifiers. The reference does not require Python access or expose a supported programming API.

Read a field table

Column or notation How to interpret it
Required: Yes The field must be supplied; check whether its type also permits null
Default: Not specified The schema declares no default; this is different from null or zero
Default: null An omitted optional field takes an explicit empty value
Type link Opens the local nested definition, including its fields and constraints
Constraints Limits on the value, length, alternatives or collection entries

The most-used input and result pages group fields by task. Nested definitions are expandable; direct links and search hits open the relevant section. Search shows one copy of an identical shared definition while every reference page retains its complete local detail. The downloadable schema remains the complete contract.

Use the glossary and units for recurring terms. For a concrete YAML excerpt and its context, start with EX01 or the topology authoring example.

Read a run

Begin with the run manifest, then follow its result index and artifact index. Inspect each result envelope before using domain payloads. Results describe separate execution and assessment states, applicability, issues and links to their inputs.

A downloaded schema describes structural constraints; it does not establish engineering validity, convergence, acceptable margins or mission qualification. Use the result's assumptions and evidence when making those judgments.

Commands and versions

Use sindri --help and the relevant command's --help for the installed version. The engineering workflow introduces validation and execution. The public reference is intentionally curated; exporting additional contracts does not make every internal structure a supported user workflow.

See the command-line reference for verified command forms and the workflow guides for operating context.