Skip to content

Study inputs

Connect one run to mission and spacecraft inputs. Multi-case experiments use a separately confirmed Design Studies plan.

Contract version: 1.0.0. Download the full JSON schema.

Use the tables for exact field names, types and constraints. Wide tables scroll horizontally. How to read defaults, units and result states.

For interpretation and examples, read project authoring.

Fields

Connect the project

Link the mission and spacecraft documents and any study resources.

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
mission Project Document Reference Yes Not specified Reference the mission document with its identifier and project-relative path.
spacecraft Project Document Reference Yes Not specified Reference the spacecraft document with its identifier and project-relative path.
resources array of Named Resource No [] —

Define the experiment

Keep scenario identities and controlled design choices consistent.

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
scenarios array of Scenario Definition No [] —
design_variables array of Allowed Set Variable or Range Variable No [] —
fixed_choices array of Fixed Choice No [] —
seed integer No 0 Record the seed with controlled comparisons; a changed seed can change a search result.

Execute and save

Choose supported capabilities and the output location.

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
execution Execution Controls No Not specified Optional execution capabilities have their own availability and failure behavior; enabling a setting does not install an external backend.
outputs Output Policy No Not specified Output location settings. The run command may explicitly override the output root.

Identity and other fields

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
contract_suite string No "sindri.contracts" const: "sindri.contracts"
contract_version string No "2.0.0" const: "2.0.0"
document_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
schema_kind string No "study" const: "study"
study_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
title string Yes Not specified minLength: 1
maxLength: 200

Nested definitions

Open a definition below, or follow a type link in a field table. Direct links open the relevant section automatically.

Adcs42 Controller

Adcs42 Controller

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
allocation_id string No "wheel_pseudoinverse" minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
controller_family_id string No "pd_attitude_rate" minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
enabled boolean No false —
gain_derivation Gain Derivation No Not specified —
gains Controller Gains No Not specified —
limits Controller Limits No Not specified —
momentum_management Momentum Management No Not specified —
momentum_unloading string No "simple" enum: ["disabled", "simple"]
objective_statement_ids array of string No [] items: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
profile_id string No "sindri_pd_v1" minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
supported_mode_ids array of string No ["nadir_hold", "inertial_hold", "detumble"] items: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
Adcs42 Execution

Adcs42 Execution

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
controller Adcs42 Controller No Not specified —
enabled boolean No false —
executable Resource Reference or null No null —
fail_on_error boolean No false —
mode string No "disabled" enum: ["disabled", "bundle_only", "run"]
reference_overrides Adcs42 Reference Overrides or null No null —
scenario_ids array of string No [] items: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
simulation Adcs42 Simulation No Not specified —
timeline Mode Timeline or null No null —
timeout_s number No 3600.0 exclusiveMinimum: 0.0
Adcs42 Reference Overrides

Adcs42 Reference Overrides

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
evidence_source_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
inertia_diagonal_kgm2 ordered array: number, number, number or null No null anyOf branch 1: minItems: 3
maxItems: 3
pointing_bound_rad number or null No null anyOf branch 1: exclusiveMinimum: 0.0
reproduction_depth string Yes Not specified enum: ["setup", "physical_trend", "exact"]
spacecraft_mass_kg number or null No null anyOf branch 1: exclusiveMinimum: 0.0
wheel_acceleration_limit_radps2 number or null No null anyOf branch 1: exclusiveMinimum: 0.0
wheel_axes_body array of ordered array: number, number, number No [] items: minItems: 3
maxItems: 3
wheel_rotor_inertia_kgm2 number or null No null anyOf branch 1: exclusiveMinimum: 0.0
zero_speed_crossing_avoidance boolean or null No null —
Adcs42 Simulation

Adcs42 Simulation

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
duration_s number No 600.0 exclusiveMinimum: 0.0
initial_body_rate_degps ordered array: number, number, number or null No null anyOf branch 1: minItems: 3
maxItems: 3
output_interval_s number No 1.0 exclusiveMinimum: 0.0
step_s number No 0.5 exclusiveMinimum: 0.0
Allowed Set Variable

Allowed Set Variable

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
field_path string Yes Not specified minLength: 1
maxLength: 512
pattern: "^[a-z][a-z0-9_]*(?:\\.[a-z0-9_]+|\\[[0-9]+\\])*$"
values array of boolean or integer or number or string Yes Not specified minItems: 1
variable_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
variable_type string No "allowed_set" const: "allowed_set"
Attitude Reference

Attitude Reference

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
primary_target string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
reference_type string Yes Not specified enum: ["rate_detumble", "lvlh_vector_hold", "inertial_quaternion_hold", "sun_vector_hold", "thrust_vector_hold", "slew_and_settle"]
target_quaternion_body_to_inertial ordered array: number, number, number, number or null No null anyOf branch 1: minItems: 4
maxItems: 4
target_vector_body ordered array: number, number, number or null No null anyOf branch 1: minItems: 3
maxItems: 3
target_vector_reference ordered array: number, number, number or null No null anyOf branch 1: minItems: 3
maxItems: 3
Controller Gains

Controller Gains

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
attitude_kp number or null No null anyOf branch 1: exclusiveMinimum: 0.0
rate_kd number or null No null anyOf branch 1: exclusiveMinimum: 0.0
Controller Limits

Controller Limits

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
magnetorquer_dipole_limit_amsq number or null No null anyOf branch 1: exclusiveMinimum: 0.0
use_hardware_limits boolean No true —
wheel_max_rpm number or null No null anyOf branch 1: exclusiveMinimum: 0.0
wheel_momentum_limit_nms number or null No null anyOf branch 1: exclusiveMinimum: 0.0
wheel_torque_limit_nm number or null No null anyOf branch 1: exclusiveMinimum: 0.0
Engineering Domain

Engineering Domain

enum: ["system", "mission", "environment", "mass", "power", "thermal", "propulsion", "adcs", "communications", "launch", "lifetime", "cost", "geometry", "placement", "deployables", "operations"]

Execution Controls

Execution Controls

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
adcs_42 Adcs42 Execution No Not specified —
geometry Geometry Execution No Not specified —
Fixed Choice

Fixed Choice

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
field_path string Yes Not specified minLength: 1
maxLength: 512
pattern: "^[a-z][a-z0-9_]*(?:\\.[a-z0-9_]+|\\[[0-9]+\\])*$"
value boolean or integer or number or string Yes Not specified —
Gain Derivation

Gain Derivation

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
damping_ratio number No 0.8 maximum: 2.0
exclusiveMinimum: 0.0
settling_time_s number No 300.0 exclusiveMinimum: 0.0
source string No "derived" enum: ["explicit", "derived"]
torque_limit_fraction number No 0.5 maximum: 1.0
exclusiveMinimum: 0.0
Geometry Execution

Geometry Execution

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
cad_backend string No "freecad" const: "freecad"
cad_export_enabled boolean No false —
check_enabled boolean No true —
deployment_state_ids array of string No ["stowed", "deployed"] items: enum: ["stowed", "deployed"]
emit_gltf boolean No true —
emit_step boolean No true —
fail_on_cad_error boolean No false —
Mode Timeline

Mode Timeline

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
segments array of Timeline Segment Yes Not specified minItems: 1
Momentum Management

Momentum Management

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
cadence_s number No 60.0 exclusiveMinimum: 0.0
deadband_fraction number No 0.5 minimum: 0.0
maximum: 1.0
enabled boolean No true —
threshold_fraction number No 0.5 maximum: 1.0
exclusiveMinimum: 0.0
unloading_gain number No 0.01 exclusiveMinimum: 0.0
Named Resource

Named Resource

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
reference Resource Reference Yes Not specified —
role_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
Output Policy

Output Policy

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
root_path string No "runs" minLength: 1
maxLength: 512
run_id string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
Project Document Reference

Project Document Reference

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
document_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
project_path string Yes Not specified minLength: 1
maxLength: 512
Range Variable

Range Variable

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
field_path string Yes Not specified minLength: 1
maxLength: 512
pattern: "^[a-z][a-z0-9_]*(?:\\.[a-z0-9_]+|\\[[0-9]+\\])*$"
maximum number Yes Not specified —
minimum number Yes Not specified —
scale string No "linear" enum: ["linear", "log"]
step number or null No null anyOf branch 1: exclusiveMinimum: 0.0
variable_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
variable_type string No "range" const: "range"
Resource Reference

Resource Reference

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
expected_sha256 string or null No null anyOf branch 1: pattern: "^[0-9a-f]{64}$"
project_path string or null No null anyOf branch 1: minLength: 1
maxLength: 512
resource_id string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
Scenario Definition

Scenario Definition

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
applicable_statement_ids array of string No [] items: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
cycle_id string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
deployable_state_id string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
description string or null No null anyOf branch 1: minLength: 1
maxLength: 1000
domain Engineering Domain Yes Not specified —
duration_fraction number or null No null anyOf branch 1: maximum: 1.0
exclusiveMinimum: 0.0
duty_cycle number or null No null anyOf branch 1: minimum: 0.0
maximum: 1.0
external_id string or null No null anyOf branch 1: minLength: 1
maxLength: 256
ground_target_latitude_deg number or null No null anyOf branch 1: minimum: -90.0
maximum: 90.0
ground_target_longitude_deg number or null No null anyOf branch 1: minimum: -180.0
maximum: 180.0
initial_body_rate_degps ordered array: number, number, number or null No null anyOf branch 1: minItems: 3
maxItems: 3
kind Scenario Kind Yes Not specified —
maximum_detumble_time_s number or null No null anyOf branch 1: exclusiveMinimum: 0.0
maximum_slew_acceleration_degps2 number or null No null anyOf branch 1: exclusiveMinimum: 0.0
maximum_slew_rate_degps number or null No null anyOf branch 1: exclusiveMinimum: 0.0
mode_id string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
priority integer No 0 minimum: 0
representative_duration_s number or null No null anyOf branch 1: exclusiveMinimum: 0.0
required_sensor_role_ids array of string No [] items: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
scenario_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
slew_angle_deg number or null No null anyOf branch 1: maximum: 360.0
exclusiveMinimum: 0.0
slew_axis_body ordered array: number, number, number or null No null anyOf branch 1: minItems: 3
maxItems: 3
slew_duration_s number or null No null anyOf branch 1: exclusiveMinimum: 0.0
tags array of string No [] items: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
target string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
target_body_rate_degps ordered array: number, number, number or null No null anyOf branch 1: minItems: 3
maxItems: 3
target_frame_id string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
target_vector_body ordered array: number, number, number or null No null anyOf branch 1: minItems: 3
maxItems: 3
target_vector_reference ordered array: number, number, number or null No null anyOf branch 1: minItems: 3
maxItems: 3
Scenario Kind

Scenario Kind

enum: ["detumble", "sun_acquisition", "safe_mode", "nadir_tracking", "target_tracking", "slew_and_settle", "thrust_tracking"]

Timeline Segment

Timeline Segment

Unknown fields are rejected for this object.

Field Type Required Default Constraints / meaning
acceptance_statement_ids array of string No [] items: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
duration_s number or null No null anyOf branch 1: exclusiveMinimum: 0.0
end_s number or null No null anyOf branch 1: exclusiveMinimum: 0.0
entry_condition_statement_ids array of string No [] items: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
exit_condition_statement_ids array of string No [] items: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
fallback_mode_id string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
gains Controller Gains or null No null —
limits Controller Limits or null No null —
mode_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
reference Attitude Reference or null No null —
scenario_id string or null No null anyOf branch 1: minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
segment_id string Yes Not specified minLength: 1
maxLength: 128
pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$"
start_s number or null No null anyOf branch 1: minimum: 0.0

Schema integrity

Schema SHA-256: d37be1fc91e4c3734499ec9bcadc931dbcc108a40511bda55856bdb96e3a759e.

Return to the reference guide.