Skip to content

OrbitFabric v1.0.0 - Stable Mission Data Contract

Status: Released
Release type: stable Mission Data Contract release
Scope: narrow stable Core surface, compatibility governance and release alignment


Summary

OrbitFabric v1.0.0 is the first stable Mission Data Contract release.

The release stabilizes a deliberately narrow Core surface around the Mission Model, validation, linting, scenario evidence, machine-readable JSON reports, Core-owned structured surfaces, release compatibility governance and the extensibility boundary.

The stable surface is intentionally limited.

OrbitFabric v1.0.0 is not a flight software framework, not a ground segment, not a mission control system, not a spacecraft dynamics simulator, not a plugin execution platform and not a tool-specific integration layer.


Stable v1.0 surface

The selected v1.0 stable surface includes:

Mission Model documented contract semantics
Core structural validation
Core semantic lint diagnostic policy
scenario YAML evidence inputs
lint JSON report
simulation JSON report
model_summary.json
entity_index.json
relationship_manifest.json for admitted families
CLI command interface for documented workflows
release compatibility policy
extensibility boundary contract

These surfaces are stable within the OrbitFabric release compatibility policy.


Core-owned structured surfaces

The v1.0 Core-owned structured surface chain is:

model_summary.json          -> What contract domains are present?
entity_index.json           -> What contract entities are defined?
relationship_manifest.json  -> How are indexed contract entities related?

These surfaces are derived from the validated Mission Model.

They are not a second source of truth.

Downstream tools and future extensions should consume these surfaces instead of reconstructing OrbitFabric Core semantics from raw YAML, generated files, human-oriented terminal output, logs, UI state or private assumptions.


Golden signature protection

v1.0.0 includes contract-significant golden signatures for selected fields of the demo-3u Core-owned structured surfaces:

tests/golden/demo_3u_core_surfaces/model_summary_contract_signature.json
tests/golden/demo_3u_core_surfaces/entity_index_contract_signature.json
tests/golden/demo_3u_core_surfaces/relationship_manifest_contract_signature.json

The related regression tests are in:

tests/test_v1_golden_core_surfaces.py

These golden signatures protect selected contract-significant fields such as:

surface kind
surface version
mission identity
boundary flags
domain counts
entity identifiers
relationship family counts
selected relationship records

They do not freeze:

full generated JSON files
absolute paths
human-oriented terminal output
Markdown wording
generated runtime bindings
generated ground dictionaries
disposable artifact formatting

v1.0 demonstration chain

The selected v1.0 demonstration chain is:

payload.start_acquisition
        -> payload.acquisition_started
        -> payload.radiation_histogram data product evidence
        -> storage intent declared
        -> downlink intent declared
        -> science_next_available_contact downlink flow
        -> demo_contact_001 contact window
        -> scenario JSON evidence
        -> runtime-facing contract bindings
        -> ground-facing dictionaries
        -> model_summary.json
        -> entity_index.json
        -> relationship_manifest.json
        -> golden signatures protecting selected Core-owned surface fields

This demonstrates Mission Data Contract continuity.

It does not demonstrate flight readiness, ground readiness, protocol compliance, tool-specific integration, security enforcement or operational completeness.


Preview or disposable surfaces

The following surfaces remain preview, disposable or non-stable unless explicitly promoted by a future release decision:

CLI textual output
generated Markdown mission documentation
plain-text simulation logs
generated C++17 runtime-facing bindings
generated ground-facing dictionaries
runtime_contract_manifest.json
ground_contract_manifest.json

Generated runtime-facing and ground-facing artifacts remain reproducible contract-facing outputs.

They are useful, but they are not flight software, not ground software and not stable runtime or ground APIs.


Explicitly out of scope

v1.0.0 does not introduce:

flight runtime behavior
ground runtime behavior
mission control behavior
telemetry archive
command uplink service
hardware abstraction layer
RTOS integration
binary telemetry decoder
binary telecommand encoder
CCSDS/PUS/CFDP implementation
XTCE export
Yamcs integration
OpenC3 integration
F Prime mapping
cFS mapping
relationship graph engine
dependency graph engine
plugin discovery
plugin loading
plugin execution
schema migration tooling
JSON Schema publication
security enforcement semantics
Studio-specific API

These topics require separate future design, implementation and testing.


Compatibility and migration

No migration is required from v0.12.0 - v1.0 Release Candidate Hardening to v1.0.0 - Stable Mission Data Contract.

The v1.0.0 release promotes the selected candidate posture to a stable release baseline.

It does not add, remove or rename Mission Model fields, model domains, controlled values, reference rules, lint diagnostics, scenario expectations, JSON report fields, generated Core surfaces or documented CLI workflows beyond the release version alignment.

The expected package version is now:

orbitfabric 1.0.0

Validation baseline

The expected release validation baseline is:

ruff check .
pytest
mkdocs build --strict

orbitfabric lint examples/demo-3u/mission/
orbitfabric validate scenario examples/demo-3u/scenarios/battery_low_during_payload.yaml
orbitfabric validate scenario examples/demo-3u/scenarios/payload_data_flow_evidence.yaml
orbitfabric sim examples/demo-3u/scenarios/battery_low_during_payload.yaml
orbitfabric sim examples/demo-3u/scenarios/payload_data_flow_evidence.yaml
orbitfabric export model-summary examples/demo-3u/mission/
orbitfabric export entity-index examples/demo-3u/mission/
orbitfabric export relationship-manifest examples/demo-3u/mission/
orbitfabric gen docs examples/demo-3u/mission/
orbitfabric gen data-flow examples/demo-3u/mission/
orbitfabric gen runtime examples/demo-3u/mission/
cmake -S generated/runtime/cpp17 -B generated/runtime/cpp17/build
cmake --build generated/runtime/cpp17/build
orbitfabric gen ground examples/demo-3u/mission/

Final release statement

OrbitFabric v1.0.0 stabilizes OrbitFabric Core as a Mission Data Contract framework.

The stable statement is:

Define the contract once.
Validate it.
Exercise scenario evidence.
Generate review artifacts.
Export Core-owned structured surfaces.
Protect selected stable surface fields with golden signatures.
Keep the Mission Model as the source of truth.

That is the v1.0.0 release boundary.