# systems-modeling/sysml-v2-release architecture

> Architecture diagram of the GitHub repository systems-modeling/sysml-v2-release, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/systems-modeling/sysml-v2-release
- Repository: https://github.com/systems-modeling/sysml-v2-release

## Overview

##### 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

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Documentation Artifacts
    subgraph "Documentation Artifacts"
        DOC["doc/"]:::docs
        KERMLPDF["Kernel Modeling Language Spec PDF"]:::docs
        SYSMLPDF["SysML v2 Spec PDF"]:::docs
        APIPDF["API & Services Spec PDF"]:::docs
    end
    DOC --> KERMLPDF
    DOC --> SYSMLPDF
    DOC --> APIPDF

    %% Installer Packages
    subgraph "Installer Packages"
        ECLIPSEPKG["install/eclipse/"]:::installer
        ECLIPSEZIP["Eclipse Plugin Site Zip"]:::installer
        JUPYPKG["install/jupyter/"]:::installer
        INSTALLSH["install.sh"]:::installer
        INSTALLPY["install.py"]:::installer
        INSTALLBAT["install.bat"]:::installer
    end
    ECLIPSEPKG --> ECLIPSEZIP
    JUPYPKG --> INSTALLSH
    JUPYPKG --> INSTALLPY
    JUPYPKG --> INSTALLBAT

    %% Model Libraries
    subgraph "Model Libraries"
        TEXTLIB["sysml.library/"]:::library
        KERMLTEXTLIB["Collections.kerml"]:::library
        XMILIB["sysml.library.xmi/"]:::library
        KERMLXMILIB["Collections.kermlx"]:::library
    end
    TEXTLIB --> KERMLTEXTLIB
    XMILIB --> KERMLXMILIB

    %% Example Models
    subgraph "Example Models"
        KERML_EX["kerml/src/examples/"]:::example
        SYSML_EX["sysml/src/examples/"]:::example
        TRAIN["sysml/src/training/"]:::example
        VAL["sysml/src/validation/"]:::example
    end

    %% External Services
    subgraph "External Services"
        GH["GitHub Releases"]:::external
        ECLIDE["Eclipse IDE"]:::external
        JLAB["JupyterLab"]:::external
        OPENAPI["OpenAPI Server"]:::external
        TOOL["Prototype Visualization Tool"]:::external
    end

    %% Downloads from GitHub
    GH --> DOC
    GH --> ECLIPSEPKG
    GH --> JUPYPKG
    GH --> TEXTLIB
    GH --> XMILIB
    GH --> KERML_EX
    GH --> SYSML_EX

    %% Installer flows
    ECLIPSEPKG --> ECLIDE
    JUPYPKG --> JLAB

    %% Library consumption
    XMILIB --> ECLIPSEPKG
    TEXTLIB --> ECLIDE
    TEXTLIB --> JLAB

    %% Example model usage
    KERML_EX --> ECLIDE
    KERML_EX --> JLAB
    KERML_EX --> TOOL
    SYSML_EX --> ECLIDE
    SYSML_EX --> JLAB
    SYSML_EX --> TOOL

    %% OpenAPI interactions
    OPENAPI -- "publish/consume" --> KERML_EX
    KERML_EX -- "publish/consume" --> OPENAPI
    OPENAPI -- "publish/consume" --> SYSML_EX
    SYSML_EX -- "publish/consume" --> OPENAPI

    %% Click Events
    click DOC "https://github.com/systems-modeling/sysml-v2-release/tree/master/doc/"
    click KERMLPDF "https://github.com/systems-modeling/sysml-v2-release/blob/master/doc/1-Kernel_Modeling_Language.pdf"
    click SYSMLPDF "https://github.com/systems-modeling/sysml-v2-release/blob/master/doc/2a-OMG_Systems_Modeling_Language.pdf"
    click APIPDF "https://github.com/systems-modeling/sysml-v2-release/blob/master/doc/3-Systems_Modeling_API_and_Services.pdf"
    click ECLIPSEPKG "https://github.com/systems-modeling/sysml-v2-release/tree/master/install/eclipse/"
    click ECLIPSEZIP "https://github.com/systems-modeling/sysml-v2-release/blob/master/install/eclipse/org.omg.sysml.site.zip"
    click JUPYPKG "https://github.com/systems-modeling/sysml-v2-release/tree/master/install/jupyter/"
    click INSTALLSH "https://github.com/systems-modeling/sysml-v2-release/blob/master/install/jupyter/install.sh"
    click INSTALLPY "https://github.com/systems-modeling/sysml-v2-release/blob/master/install/jupyter/install.py"
    click INSTALLBAT "https://github.com/systems-modeling/sysml-v2-release/blob/master/install/jupyter/install.bat"
    click KERML_EX "https://github.com/systems-modeling/sysml-v2-release/tree/master/kerml/src/examples/"
    click SYSML_EX "https://github.com/systems-modeling/sysml-v2-release/tree/master/sysml/src/examples/"
    click TRAIN "https://github.com/systems-modeling/sysml-v2-release/tree/master/sysml/src/training/"
    click VAL "https://github.com/systems-modeling/sysml-v2-release/tree/master/sysml/src/validation/"
    click TEXTLIB "https://github.com/systems-modeling/sysml-v2-release/tree/master/sysml.library/"
    click KERMLTEXTLIB "https://github.com/systems-modeling/sysml-v2-release/blob/master/sysml.library/Kernel Libraries/Kernel Data Type Library/Collections.kerml"
    click XMILIB "https://github.com/systems-modeling/sysml-v2-release/tree/master/sysml.library.xmi/"
    click KERMLXMILIB "https://github.com/systems-modeling/sysml-v2-release/blob/master/sysml.library.xmi/Kernel Libraries/Kernel Data Type Library/Collections.kermlx"

    %% Styles
    classDef docs fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef installer fill:#d4edda,stroke:#333,stroke-width:1px
    classDef library fill:#fff3cd,stroke:#333,stroke-width:1px
    classDef example fill:#ffe5b4,stroke:#333,stroke-width:1px
    classDef external fill:#e2e3e5,stroke:#333,stroke-width:1px
```
