Skip to content

SysML v2 Local Lab Documentation

This documentation set supports the shareable SysML v2 local lab kit, private model workspace usage, SysML v2 modeling guidance, and publishable model specifications.

Start Here

Goal Start with Then use
Install and operate the lab CLI CLI CLI Reference
Start, stop, or inspect services Services Troubleshooting
Keep private model data out of the tooling repo Private Model Workspaces Safety And Sharing
Move a Flexo model snapshot into SysON Bridge Workflow Transformation Pipeline
Understand supported rendered SysML v2 content Modeling Conventions Bridge Workflow
Prepare or publish a release Release Process v0.2.0 Limitations
Extend the local harness or evals Harness Engineering Plans
Plan roadmap or feature work Roadmap Feature Proposals

Which Command Should I Run?

Goal Command
Install the CLI make install-cli
First setup mbse-lab bootstrap --model-workspace ~/work/my-private-models
Check environment mbse-lab doctor
Start services mbse-lab services up
Create demo model mbse-lab first-model "My First Model"
Prove first-use path mbse-lab smoke first-use --json-output
Bridge existing model mbse-lab bridge run <flexo-project-id> --create-syson-project "Imported From Flexo"
Collect diagnostics mbse-lab diagnostics
Generate report mbse-lab report
Clean generated local output mbse-lab cleanup --dry-run
Before sharing mbse-lab share-check

Use the mbse-lab command surface for routine work. Direct script and Docker commands are advanced/manual recovery paths in the deployment and bridge pages.

Local Lab Flow

flowchart LR
    setup["CLI setup and doctor"]
    flexo["Flexo MMS<br/>SysML v2 API"]
    snapshot["Flexo JSON export<br/>rendered .sysml"]
    syson["SysON<br/>graphical review"]
    evidence["reports, diagnostics,<br/>eval evidence"]

    setup --> flexo --> snapshot --> syson
    setup --> evidence
    snapshot --> evidence

User Guide

Page Use it for
Private Model Workspaces Separating reusable tooling from private SysML v2 source, exports, run logs, and service data.
CLI Installing mbse-lab, running doctor/bootstrap, managing services, creating a first model, and using bridge commands.
CLI Reference Generated command and option reference built from the Click command tree.
Services Starting, stopping, checking, and maintaining the local Flexo and SysON services.
Safety And Sharing Credential, service-data, private-workspace, share-check, report, and cleanup boundaries.
Troubleshooting Symptom-oriented recovery paths for Docker, ports, Flexo org setup, SysON startup, and bridge imports.
Release Process Preparing release branches, smoke testing, tagging, and syncing release work back to develop.
v0.2.0 Limitations Tracking release-scope limits, known gaps, and downstream development focus areas.

Roadmap

Page Use it for
Roadmap Maintaining Now/Next/Later priorities, roadmap themes, out-of-scope boundaries, and planning gates.

Local Lab

Page Use it for
Bridge Workflow Exporting from Flexo, rendering textual SysML v2, and importing into SysON.
Harness Engineering Understanding command surfaces, guardrails, evals, diagnostics, and agent-oriented operating rules.
Feature Development Agent Prompt Copyable fresh-agent prompt for proposal-backed feature implementation.
Feature Development Prompt Pack Filled, copyable prompts for selected proposal-backed feature issues.
Modeling Conventions Checking which Flexo element types are rendered into textual SysML v2 and how names are sanitized.
View Editor Flexo Experiment Final compatibility report and request evidence for the experimental OpenMBEE View Editor deployments.

Methodology

Page Use it for
Verification Model Setup Organizing SysML v2 packages, requirements, architecture, configurations, analysis, and verification content.
Transformation Pipeline Designing model-to-analysis, model-to-document, and evidence import pipelines around SysML v2 source content.

Model Specs

Page Use it for
MBSE Lab Tool System Modeling this repo's own requirements, architecture, workflows, verification concepts, and rendered fixture artifacts.
RF Link Budget Modeling RF link margin, budget equations, requirements, analysis cases, and verification evidence.
CCA Rollup Modeling circuit-card power, mass, cost, labor, test, and rollup verification.
RF to Digital Signal Chain Modeling RF front-end, ADC, DSP, signal quality, and response artifacts.
Container Deployment Modeling container services, ports, volumes, health checks, persistence, backup, and runtime verification.
Security Architecture Modeling security assets, enclaves, controls, risks, mitigations, and evidence records.
Enterprise Architecture Modeling capabilities, activities, services, resources, projects, and enterprise traceability.

Plans

Page Use it for
Plans Feature proposal and execution plan conventions for planned, active, and completed work.
Feature Proposals Deciding feature shape, non-goals, validation, and safety impact before implementation starts.
Feature Pre-Plan Template Copyable proposal template for roadmap-changing or risk-bearing feature work.
Backup-First Reset Workflow Proposed safe reset workflow with backup, dry-run, and confirmation gates.
Bridge Import Preflight Proposed pre-import checks for snapshot quality, render coverage, and target context.
Bridge Snapshot Diff Proposed comparison workflow for bridge snapshots, rendered text, and render reports.
Environment Profiles Proposed named non-secret config profiles for advanced local and endpoint workflows.
Model-Like JSON Share Check Proposed share-check heuristic for tracked Flexo/SysML-looking JSON.
Optional SysML v2 Starter Libraries Proposed public starter library catalog for optional model scaffolding.
Polished HTML Report Proposed structured static HTML report for workflow evidence.
Snapshot Evidence Bundle Proposed public-safe evidence bundle for bridge run handoffs.
SysML Coverage Matrix Gate Proposed bridge coverage matrix tied to fixtures and deterministic tests.
MVP Feature Catalog Current MVP feature status, evidence, gaps, and validation work.
Usability Remediation Active work plan for converting the usability review into validated safety, onboarding, and bridge improvements.
SysML JSON Rendering Reuse Spike Active spike on reuse options for SysML JSON rendering and import workflows.
View Editor Flexo Experiment Completed direct-compatibility spike and final adapter decision.
MBSE Lab SysML Model Active plan for keeping the lab tool-system model, fixture, and curated render output aligned.

Reviews

Page Use it for
Usability Review Static usability assessment and prioritized findings for the local lab kit.
Recommended Features Review Product direction, capability map, milestone recommendations, and feature backlog for the local lab kit.
Recommended Sprint Sequence Sprint sequencing, acceptance gates, project-board fields, and dependency map for near-term execution.