Author a project¶
Start from a Console starter or a worked-study download, then change one engineering assumption and assess a new run. For a first visit, follow your first Console run before adapting the inputs.
Keep the original project or completed run as your baseline. A downloaded study contains editable inputs and a resource manifest; use it with the compatible runtime described under access and setup.
Choose an editing route¶
| Task | Route |
|---|---|
| Adapt a complete example | Configure → Load Example, then select the closest starter |
| Change common mission or hardware inputs | The Mission, Spacecraft and Subsystems sections |
| Inspect or select packaged hardware | Catalog, then Use in configuration |
| Edit an input without a guided control | The expanded YAML editor, or the downloaded project files |
For each change: save the project, select Validate, review its diagnostics, then start a new run. Validation checks the inputs; the completed calculation establishes the resulting engineering assessments. Use monitoring to follow execution and result interpretation to decide what to change next.
Three documents, one study¶
| Document | Owns | Check when editing |
|---|---|---|
mission.yaml |
Orbit, life, operations, engineering statements, subsystem design intent and evidence | Units, mode fractions, requirement definitions and evidence IDs |
spacecraft.yaml |
Payloads, component selections, catalog profiles and physical/policy choices | Per-item quantities, hardware applicability, ownership/margins and state/frame choices |
study.yaml |
Mission/spacecraft references, scenarios, resources, execution/output settings and seed | Referenced document IDs/paths, scenario mode IDs and supported optional capabilities |
Documents are strict: unknown fields fail validation. The contract suite/version and document identity are not arbitrary labels. Use the generated field reference to distinguish a required field from a defaulted field, and an omitted value from an explicit null. Do not paste an entire partial fragment as a replacement document.
Keep project-relative paths contained. Named runtime resources must exist in the compatible runtime; local resources need their declared role and reference. Digests bind the resolved study to actual resource contents. Renaming a file without updating its reference does not update the project.
Example: fix the topology¶
EX01 holds the topology choice fixed so that the run evaluates one declared
layout. This is the policies.topology section of its spacecraft.yaml:
mode: fixed
fixed_topology_id: starter_flat_v1
allowed_topology_ids:
- starter_flat_v1
Keep this excerpt at its existing nesting level; it is not a standalone document. The fixed selector and allowed list must agree. EX04 changes those two IDs together with the launcher-orientation selector and its allowed list. It compares a flat deck mounted along body X with a spine mounted along body Z, holding the mission and hardware fixed. Use that complete download for the paired study.
Make a controlled change¶
In the Console¶
Load Example creates an editable working copy without changing the library or starting a run. The catalog covers spacecraft sizes, a controlled topology pair, constrained packaging, deployable arrays and a 42 handoff. Search by name or purpose and read the example's execution guidance and tool requirements before selecting it. Run the topology variants separately; successful execution is not a statement that either design meets its engineering requirements.
Configure > Mission separates orbit/environment, operating modes, requirements, scenarios and margins. Modes and scenarios can be added, duplicated, reordered and removed. A referenced identifier cannot be renamed or removed until its uses have been updated. Mode fractions are never normalized automatically; validate after changing the operating plan.
Configure > Spacecraft contains payloads, mass ownership, topology, placement face rules, array/deployable policies, body axes, launcher orientation and launch-envelope dimensions. Envelope limits are not spacecraft dimensions; bus sizing and solar-array area remain owned by the existing engineering models.
Configure > Subsystems groups power, thermal, propulsion, communications, ADCS and cost inputs. Communication paths, contacts and data budgets remain separate authored inputs within the same section. Common vectors have individual numeric coordinates. 42 controller and timeline controls appear when 42 is enabled under Run. Timeline acceptance references the mission's engineering statements; it does not create a second set of requirements.
Power's Operating depth of discharge sets
mission.eps.battery_depth_of_discharge as a fraction from greater than zero to
one. It controls battery sizing and lifetime assumptions before the battery
sizing margin; it is not the hardware catalog's cycle-life reference DoD. Reset
inherits the selected power profile's default again.
Configure > Catalog browses packaged hardware, topology templates and
architecture hierarchies. Inspect a topology's shell, mounts and keepouts or an
architecture's component roles before selecting it. Use in configuration
stages a supported selection for Save and Validate; it does not run the solver,
prove compatibility or modify the library. Packaged properties and definitions
remain read-only. For supported hardware, Customize creates a project-owned
copy with a user. identifier. Change the supported properties, describe their
source or rationale, validate, and save the copy. Saving a copy does not select
it: use Use in configuration, then Save and Validate the project. Save or
discard other configuration changes before editing hardware.
Recovery drafts are revision-guarded across browser tabs. If another tab changes a draft, export your unsaved edits before reloading; the Console will not replace the other tab's recovery copy automatically.
Custom hardware uses the same family validation and solver binding in the CLI and Console. Modified values are user-authored engineering estimates, not a continuation of the original supplier's verification. Project resources are digest-pinned; editing creates a new revision rather than replacing bytes used by an earlier run or checkpoint. Project exports include referenced resources. Remove configuration references before removing a custom entry. Topology and architecture definitions remain inspection/selection-only.
Save applies guided edits to the three project documents. Unedited source and comments are retained. Reset removes an override rather than writing the current default as an explicit value. Validate checks the complete saved project; saving an intermediate draft is not a validation pass. Expanded YAML editing remains available for inputs not yet exposed by the guided sections.
In a project folder¶
- State the engineering question and choose the smallest relevant input change.
- Keep unrelated mission, hardware, seed and resource versions fixed.
- Update dependent identifiers/state references if the change requires them.
- Validate the complete project, then execute it as a new run.
- Compare result states before budgets; retain the input snapshot and evidence.
sindri validate-project my-project/study.yaml
sindri run my-project/study.yaml --output-root my-runs
Replace these example paths with your project and chosen output directory. Validation loads all three documents, cross-references and resolved resources; it does not execute solvers or prove engineering feasibility.
Evidence records should separate sourced facts, assumptions and estimates. A requirement needs a quantity, unit and applicable criterion; a sentence in a title alone is not a machine-evaluated acceptance test. Do not reuse a held-out mission outcome as a tuned input and then claim independent agreement.
Use Design Studies to run a bounded multi-case experiment.
Current authored study documents use version 2.0.0; an embedded sweeps field
is not supported. Mission and spacecraft retain their own contract versions.
Optional capabilities¶
CAD/export backends and specialist executables have their own availability requirements and error policies. Enabling an option does not install a backend. Read the recorded geometry/backend status if a nonfatal export fails; a missing CAD artifact is not a successful CAD qualification.
Use run control for execution and run recovery if work is interrupted, then bundle inspection for the resulting evidence. For exact inputs see mission, spacecraft and study.