Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 

Repository files navigation

Awesome SysML V2 Awesome

A curated list of SysML v2 language tools, implementations, samples, syntax highlighters, editors, commercial tools, and containerized versions.

Contents


Documentation & Standards

  • sysml-v2-docs - Pure markdown knowledge base extracted from OMG SysML v2.0 / KerML 1.0 / API & Services 1.0 specs. Covers the full language (overview, grammar, keywords, definition vs usage, structural/behavioral/requirements modeling, analysis, packages, standard libraries, graphical notation), AI agent guidance, validation checklists, and example .sysml files (flashlight, vehicle skeleton). Designed for both developers and AI coding agents.

Reference & Pilot Implementations

  • SysML v2 Pilot Implementation - OMG's reference implementation — Java/Xtext-based parser, validator, textual editor, and PlantUML visualization. Memory-heavy JVM runtime — 16 GB host RAM recommended. LGPL-3.0.
  • SysML v2 API Services - Reference REST API server (Spring Boot) implementing the OMG SysML v2 API & Services specification. Spring Boot JVM — 16 GB host RAM recommended.
  • SysML v2 Release - Official OMG release repo — spec documents, example models, model library, and installer instructions.

Language Servers & VS Code Extensions

  • sysml-v2-lsp - Full LSP in TypeScript/ANTLR4 — diagnostics, completions, goto-def, references, rename, code actions, semantic tokens, folding, Mermaid preview (6 diagram types), MCP server. Clients: VS Code, Web SPA, Python/Jupyter. MIT. npm install sysml-v2-lsp.
  • VSCode SysML Extension - Rich VS Code extension — 10 diagram views (General, IBD, Activity, State, Sequence, Package, etc.), Model Explorer, Feature Explorer, Feature Inspector, 29 snippets, model dashboard, inlay hints, PNG/SVG export.
  • SysIDE Editor Legacy - Free LSP-based VS Code extension — semantic highlighting, autocompletion, validation, formatting, navigation, folding, rename, hover docs. Also: Sysand (open-source package manager), Syside Modeler (premium), Syside Automator (Python). Site.
  • sysmlv2-language-server - Langium-based LSP with 210+ validation rules, TextMate grammar, EMF compatibility shim. Built with Langium.

Formatters, Linters & Style Checkers

  • sysml-style - SysML style checker and formatter based on sysmlpy. Enforces consistent code style on .sysml files. Python.

Parser Libraries & CLI Tools

  • sysml-v2-parser - Rust crate for parsing SysML v2/KerML textual syntax into AST. Resilient editor mode returns partial AST + diagnostics.
  • sysml2 CLI - Swiss-army-knife CLI — parse, validate, query (--select), modify (--delete/--set), JSON/SysML output. PEG parser with Clang-style diagnostics.
  • sysml-reactflow - Pure SysML v2.0 building blocks for React Flow — 60+ element types, 30+ edge types, viewpoint system, elkjs layout. TypeScript/React.
  • Tessera - CLI + Tauri desktop app — tolerance analysis, BOM management, SysML v2 import/export round-trip. Rust/Svelte. Site.

Python Tools

  • sysmlpy - Pure Python ANTLR4-based parser — Pint units, NetworkX/Kuzu graph backends, in-memory/graph storage abstraction, 123/123 conformance. pip install sysmlpy.
  • Windseeker - CLI for dependency analysis, Jupyter notebook generation/execution, SVG/PNG view extraction from .sysml files. pip install sysml-windseeker.
  • SysML v2 Visualizer - Python CLI driving the official jupyter-sysml-kernel to render authentic SVG diagrams (Tree, Interconnection, Action, State, Sequence, Case, MIXED) from .sysml files. Auto-discovers kernel; ships Python API, --diagnose, and GitHub Actions integration. UV-managed. Drives the in-process SysML kernel JVM — same ≥ 16 GB host RAM guidance applies.
  • sysmlcad - Embedding 3D CAD in SysML v2 for parametric models of physical objects. Python.
  • sysml2py - Original textX-based Python parser (predecessor to sysmlpy). pip install sysml2py.
  • Open-MBEE Python Client - Client library for SysML v2 REST API (Flexo) — CRUD on projects, commits, branches, elements, tags.
  • SYSMOD SysML v2 API + MCP - Flask REST API + MCP server for SYSMOD models — problem statements, system ideas, contexts, stakeholders, requirements, use cases, feature trees, quality checks, AI wizard.
  • Syside Automator - Commercial Python library — load/query/create/modify SysML v2 models, type hierarchies, JSON import/export, ReqIF export, Markdown docs. pip install syside.
  • PySAM SysML2 - Python scripting interface for SysML v2 models via Ansys SAM — browse, edit, sync back. MIT. Docs.
  • PySysML2 - ANTLR4 Python parser — export to Pandas DataFrames, Excel, Graphviz, NumPy. Apache-2.0.
  • mbse4u-sysml-helpers - Python helper library for SysML v2 API — element queries, caching, metadata. pip install mbse4u-sysml-helpers.
  • sysml-v2-code-generator - Flask web GUI for code generation from SysML v2 models. pip install fcp89-sysml-v2-code-generator-web-gui.
  • sysmlv2-python-cookiecutter - Cookiecutter template — Hatch + VS Code + SysIDE + Jupyter kernel project scaffolding.
  • daltskin LSP Python client - Zero-dep Python LSP client + Jupyter notebook — drives sysml-v2-lsp over stdio JSON-RPC.
  • Refinery Validation Pipeline - Pattern-based validation — Python pipeline fetching from SysML v2 API, transforming to Refinery graph solver, returning human-readable issues.

.NET Tools

  • SysML2.NET - C# SDK — core model, JSON/XMI/MessagePack serializers, REST/DAL clients, Docker image, live demo viewer. Viewer.

Graphical Editors & Viewers

  • Eclipse SysON - Open-source web-based graphical modeler built on Sirius Web. Drives Papyrus SysMLv2 & Capella co-design. Docs.
  • Open-MBEE sysmlv2-web-modeler - Standalone Java web service — graphical rendering + textual editing against any SysML v2 API backend. Dockerized.
  • sysmlv2-gui - Native desktop + WebAssembly web graphical viewer — Rust/egui, reads .sysml files, renders OMG-specified graphical notation.
  • Tom Sawyer SysML v2 Viewer - Model visualization — auto-layout, interactive navigation, integrates with any SysML v2 API repo.

Validation & Analysis

  • Refinery Validation Pipeline - Pattern-based validation — connects to SysML v2 API, transforms to Refinery graph solver, runs user-defined patterns. Docker Compose showcase.
  • SYSMOD MCP Server - 17 MCP tools for querying SYSMOD artifacts — quality checks, atlas, feature trees, AI suggestions.
  • cameo-mcp-bridge - MCP server bridging AI assistants to CATIA Magic/Cameo — 37 tools for query, create, modify, diagram operations on SysML/UML models.

Syntax Highlighting & Grammar Files

Samples, Examples & Training

  • SysML v2 Release examples - Official OMG example models (KerML and SysML v2) — the canonical starting point (kerml/, sysml/).
  • GfSE SysML v2 Models - GfSE-curated collection of high-quality SysML v2 models — validated in CI via the Pilot Implementation parser. Covers SE models, EveOnline mining frigate, family model, SOS, and more. BSD-3-Clause.
  • Airbus Apollo 11 SysML v2 - Comprehensive SysML v2 model of the Apollo 11 mission by Airbus Central R&T. Uses the 5-layer CoSMA framework (Purpose/Operational/Functional/Logical/Technical) with full requirements traceability, analysis calculations, state machines, and mission execution modeling. Research artifact with accompanying INCOSE paper.
  • Don't Panic Batmobile - Batmobile SysML v2 example from the book "Don't Panic - The Absolute Beginners Guide to SysML v2" by Tim Weilkiens and Christian Muggeo. Includes .sysml textual notation and Jupyter notebook. Apache-2.0.
  • SysML v2 Standard Library - Normative model libraries (Kernel, Domain, Systems libraries) (sysml.library/).
  • SysML v2 Intro Presentations - Official OMG intro PDFs for both textual and graphical notation (doc/).
  • Flashlight Starter Model - OMG starter model by Sanford Friedenthal — simple flashlight in Jupyter + PlantUML. Updated for the SysML v2 2025-04 spec release. Model organization (Requirements, Actions, Parts, Requirements Allocation), requirements tree, action tree, parts tree, on/off states. (.sysml · .ipynb · Overview).
  • SysON Flashlight Tutorial - Obeo's beginner-friendly step-by-step SysML v2 tutorial (Flashlight model).
  • SysML v2 Learning Club - OOSE's 107-lesson microlearning course — bite-sized units with exercises and quizzes.
  • Advent of SysML v2 - Sensmetry's 24-lesson video course with YouTube playlist, blog posts, and example models. (YouTube).
  • SysML Cheatsheet - Sensmetry's quick-reference cheat sheet for SysML v2 syntax.
  • SysML Syntax Explorer - Interactive browser-based concrete syntax tree (CST) visualizer. (Docs).
  • Visual Paradigm 8-View Guide - 9-part tutorial series building a Smart Home Climate System end-to-end.
  • Visual Paradigm Tutorials - Getting started, parts & ports, industry examples (EV Charging Station, Turbojet, Camera).
  • Visual Paradigm Examples - 500+ professional example files (satellite, automotive, camera, turbojet) with AI explanations.
  • sysml-v2-lsp examples - 20+ example .sysml files including bike, smart-home, DFA coverage, multiplicity.
  • SysML v2 Pilot examples - Example projects shipped with the Pilot Implementation.
  • sysml2 CLI examples - Example models for the Swiss-army-knife CLI.
  • Armstrong Process Group Tutorial - Half-day SysML v2 overview — language architecture, structure, behavior, requirements.
  • Caltech CTME Training - 3-day professional transition training from SysML v1 to v2 with Cameo.
  • Webel IT Australia Workshop - 5-day full SysML v2 workshop with Cameo/CATIA Magic, Balls & Boxes sample problem.

Commercial Tools

  • CATIA SysML v2 (Magic/Cameo) - Dassault Systèmes. 100% spec-conformant, bidirectional text↔diagram sync, Teamwork Cloud, REST API, Community Edition free.
  • Systems Modeler with SysMLv2 - Siemens. Web-based collaborative, Teamcenter PLM integration, REST/OSLC/API.
  • Simcenter Studio - Siemens. Architecture generation + evaluation, Python, ML-based trade studies.
  • Ansys SysML v2 (SAM) - Ansys / Synopsys. Cloud-native, real-time collab, config mgmt, time-dynamic execution.
  • Davinci - Celedon. SysML v2 + CAD generation + document authoring + code synthesis.
  • Syndeia - InterCAX. Digital thread platform — connect SysML v2 to requirements, SW, HW, V&V, manufacturing.
  • SysML v2 Studio - Visual Paradigm. Web-based, AI-powered code gen, 500+ examples, real-time diagram sync.
  • PTC Modeler - PTC. UML/UAF/SysML 1&2, Codebeamer/Windchill integrations, variability mgmt.
  • SysGit - Git-based infrastructure, textual + graphical editing, DevOps integration for SysML v2 models.
  • TEAMS Toolset - Qualtech Systems (QSI). Import SysML v2 for FMEA/FMECA/FTA, diagnostics/prognostics, digital twin.
  • Violet Labs Integration - Violet Labs. Digital thread between SysML v2 and CAD/PLM/ERP/hardware tools.
  • Mgnite - JupyterLab + Python environment integrating SysML v2 with Excel, PowerPoint, MATLAB/Simulink, DOORS Next.
  • Syside Modeler - Sensmetry. Premium SysML v2 modeling environment.
  • Syside Automator - Sensmetry. Python library for analysis, optimization, and workflow automation.

Containerized / Docker Images

⚠️ Memory note: Images based on the SysML v2 Pilot / API Services (gorenje/sysmlv2-jupyter, josh-kaplan/sysml-v2-docker, jaydeanmartin/sysmlv2, mbsemashup/sysmlv2-api.pilotimpl, mycr0ft/sysmlv2-jupyter-container, kenji-miyuke/sysml-v2-docker/eclipse, Open-MBEE sysmlv2-web-modeler, DeciSym sysmlv2-gui, Refinery Validation Showcase) bundle a JVM and often a Spring Boot server alongside JupyterLab/Eclipse. Combined overhead routinely exceeds 8 GB — run them on hosts with ≥ 16 GB RAM (preferably more when also running PostgreSQL). Containerizing is a good way to keep host deps clean, but plan host memory accordingly.

Tools by mycr0ft

This list's maintainer, Jon Fox (github.com/mycr0ft), maintains the sysmlpy, sysmlcad, sysml-style, pygments-sysml, sysml-vim, sysmlv2-jupyter-container, and SysON_podman_compose projects indexed above — and also contributes to the Windseeker CLI listed under Python Tools.


Contributing

Submit a PR or open an issue at github.com/mycr0ft/awesome-sysml.

About

A curated list of SysML v2 language tools, implementations, samples, syntax highlighters, editors, commercial tools, and containerized applications.

Topics

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors