How systems-modeling/sysml-v2-release works
Project Type and Purpose
• This repository is a *specification release* and reference implementation for SysML v2 (and the underlying KerML and API/Services specs).
• It bundles PDF spec documents, example models, normative model libraries (textual and XMI), and installers for Eclipse and Jupyter integration.
File‐Structure Analysis
• Top‐level modules:
• doc/ – PDF presentations and specification documents (KerML, SysML v2, API & Services)
• install/ – Two subfolders:
– eclipse/: AsciiDoc and PDF instructions plus a zipped Eclipse plugin site (org.omg.sysml.site.zip)
– jupyter/: Shell, Python, and batch installers for a SysML kernel for JupyterLab
• kerml/ – Example models in textual Kernel Modeling Language (.kerml files)
• sysml/ – Example models in textual SysML v2 (.sysml files) plus training and validation suites
• sysml.library/ – Normative libraries in textual notation (.sysml or .kerml)
• sysml.library.xmi/ – Same libraries serialized as Eclipse XMI (.sysmlx, .kermlx)
• Configuration metadata: .gitignore, .project, .settings for Eclipse; LICENSE and LGPL files for licensing
README Insights
• Lists each spec’s PDFs, example‐model sets, and installers
• Points to external services: GitHub Releases (for zip archives), a live OpenAPI docs server, and a prototype visualization tool
• Licensing mix: Creative Commons for presentations, LGPL v3.0 for code/models
a. Main Components
• Specification Documents (doc)
• Installer Packages (install/eclipse & install/jupyter)
• Model Libraries (sysml.library & sysml.library.xmi)
• Example Models (kerml & sysml)
• External Services:
• GitHub Releases (artifact hosting)
• JupyterLab + SysML kernel runtime
• Eclipse IDE + SysML/KerML plugins
• OpenAPI server (sysml2.intercax.com)
• Prototype visualization tool (Tom Sawyer)
b. Component Interactions
• install/eclipse → Eclipse IDE (plugin install path)
• install/jupyter → JupyterLab (language kernel registration)
• sysml.library.xmi → Eclipse plugin (reads .sysmlx for code completion)
• Example Models → consume either textual notation editors (Eclipse, Jupyter) or prototype tool via API
• OpenAPI server ←→ model repositories (live read/publish operations via %publish)
c. Architectural Patterns & Principles
• *Modularity*: clear separation of documentation, tooling, and model content
• *Layered distribution*: spec PDFs at top, installers in the middle, model libraries at bottom
• *Extensibility points*: new example sets, additional editors/tooling can plug into the install/ library modules
d. Key Technologies
• Git/GitHub (version control & releases)
• AsciiDoc/PDF for docs
• Eclipse XMI (.sysmlx, .kermlx)
• Jupyter kernels (Python installer scripts)
• LGPL v3.0 licensing