Start here (by role)

Use this page to pick the shortest “golden path” based on what you’re building.

Common prerequisites:

• Docker + Docker Compose v2 (docker compose)

• SPX_PRODUCT_KEY in your environment

• Optional: SPX_BASE_URL (defaults to http://localhost:8000)

Integrator (protocol + SUT client)

Goal: run SPX Server, expose a protocol adapter, and point your client/driver at it.

1. Start the server: Installation Guide

2. Build a minimal model + instance: Build Your First Simulation

3. Choose an adapter + expose ports: Choose a protocol adapter

4. Use a known-good example model for your protocol (from spx-examples):

   • Modbus: energy_meter_iem3000__modbus.yaml

   • MQTT: environment_sensor__mqtt.yaml

   • SCPI/ASCII: multimeter__scpi.yaml

5. If something fails, start with: Common Issues and Solutions

Pack-based quickstart (installer)

Goal: launch a ready-to-test stack with models, services, and optional UI.

1. Use the installer workflow: Installer and Packs (spx-examples)

2. Pick a pack + quickstart profile (smart building, energy, lab, industrial)

3. Start the generated bundle with spx-start and validate your SUT

Developer (model authoring + extensions)

Goal: author models and reusable custom logic (components/actions) safely and test-gate changes.

1. Understand core terms: Core Concepts

2. Learn the SDK building blocks: SPX SDK

3. Add custom Python logic: Extend with a Custom Component

4. Packaging/imports:

   • Registry

   • Imports

5. Validate with tests: Testing and Validation

QA/CI (MiL tests + snapshots)

Goal: run deterministic MiL suites locally and in CI, with reproducible starting state.

1. Drive SPX from tests: Use in Unit Tests (MiL)

2. Wire into pipelines: CI/CD Setup (GitHub Actions)

3. Use Snapshots as fixtures when needed: Snapshots — Getting Started

4. Pin versions and upgrade safely: Release Notes