Skip to main content

kits

The kits repository provides reusable building blocks for models on the Sedaro platform. Its kits cover agents, subsystems, sensors, communications, analytics, and other common modeling capabilities. Compose and configure them to build scenarios, run uncertainty studies, and analyze mission concepts without recreating each capability yourself.

The repository also includes tools for generating editable Blueprints, shared workflows for preparing and simulating models, and guides and examples. Its Python package is published as sedaro-kits and imported as sedaro_kits.

See the Content Repositories overview for how Kits works with the Sedaro framework and ModSim.

Available kits​

Kits can be composed within the same model. For example, a satellite can combine trajectory, attitude, power, and thermal models, while sensors and analytics describe what it observes and how it performs. The available model types are defined as SedaroML Ontologies; their fields and relationships provide the configuration you work with in a Blueprint or Python code.

Browse the Kits repository on your deployment for the available models, source code, and current documentation. Follow the repository's guides and API docstrings to learn how to compose and use the models. Access uses your deployment's repository permissions.

Start from a Blueprint preset​

Blueprint presets provide curated selections of model types and authoring metadata, with optional starting instances. They are a convenient starting point for configuring a model in the platform or extending it in Python. The preset catalog includes communications, trajectory, attitude, study, and mission configurations.

Generation is local and requires no platform login. Open the resulting SML document as a Blueprint in the platform and populate or customize it before simulation. Preset defaults are authoring starting points; for example, the trajectory preset supplies an empty Scenario. Developers can also use the Python API in the sedaro repository to customize the selected types and add model instances. See docs/blueprints.md in the repository for the complete preset catalog, usage instructions, and examples.

Prepare and simulate models​

The repository supplies two canonical workflows:

WorkflowPurpose
Simulation: workflow/workflow.yaml (sedaro-kits)Prepare the model, run scenarios and study samples, evaluate configured measures, and publish dashboards and results.
Model resolution: workflow/resolve/workflow.yaml (sedaro-kits-resolve)Expand macros into an editable resolved.sml model, available through the RESOLVED_MODEL output, without running a simulation.

Macros, found in the macro kit, describe model structure that is expanded before simulation. For example, a constellation macro describes how to generate agents from a template. The model resolution workflow lets you inspect or edit those generated agents. The simulation workflow also resolves macros as part of preparing a model for execution.

Once the simulation workflow is available on your deployment:

  1. Author an .sml Blueprint artifact containing a scenario configured using one or more kits.
  2. Select that artifact as the workflow's MODEL input and run the workflow. It prepares the model, executes simulations of any configured scenarios and studies, and uses the simulation output to evaluate performance measures.
  3. Open the .svl dashboard output artifact to inspect playback, analytics, and other outputs derived from simulation results.

See Workflow Getting Started for making a repository's workflow definitions available and running them. The Kits workflow/README.md covers both workflows, their inputs and outputs, local execution, and deployment.

Explore the results​

The simulation workflow produces results appropriate to the model:

  • Scenarios produce dashboards with playback and charts or other widgets suggested by their model components.
  • Studies enable Monte Carlo studies and other stochastic analyses. They vary uncertain inputs across runs and produce aggregate dashboards with input distributions, measure outcomes, and links to individual run results.
  • Mission engineering analyses assemble selected resources and conditions into scenarios and studies, with dashboards linking selections, run results, and applicable baseline comparisons.

For a document with a single executable root, MAIN_DASHBOARD links to its result dashboard when available. DASHBOARDS lists the published dashboards. Dashboard files reference the simulation's series data artifacts, which hold the dynamic results.

See docs/playback-suggestions.md in the repository for how kits contribute playback entities and widgets and how to customize the resulting dashboards.