Syside Modeler

The most powerful SysML v2 modeling environment in VS Code

Syside Modeler transforms your VS Code into a comprehensive systems modeling environment, providing advanced language support and visualization capabilities for the SysML v2 and KerML languages.

Modeler provides means to work effectively with both textual & graphical model representations, collaborate, and manage large-scale models. Modeler's visualization capabilities are powered by Tom Sawyer Software’s SysML v2 Viewer.

Free 30-Day Trial: Get started with the Solo plan that includes Syside Modeler and Syside Automator — cancel anytime.

Table of Contents

• Getting Started
• Features
  • Model visualization
    • Interactive tree view
    • Export diagram
    • Show source code
    • Navigate links
    • Search diagram
  • Textual editing
    • Model validation
    • Semantic highlighting
    • Model navigation
    • Documentation on hover
    • Renaming
    • Document outline
    • References
    • Folding
    • Auto-completion
    • Auto-formatting
• Useful Resources

Getting Started

1. Install Syside Modeler from the VS Code marketplace

2. Open any (.sysml) SysML v2 file

3. Explore features (see Modeler documentation)

4. Visualize your model by:

   • Using keyboard shortcut CTRL+SHIFT+V (Windows, Linux) or CMD+SHIFT+V (MacOS)

   • Using VS Code command (CTRL+SHIFT+P (Windows, Linux) or CMD+SHIFT+P (MacOS) and selecting Syside Modeler: Visualize current file )

   • Using the quick launch button:

     

Got questions, concerns or ideas? Talk to us directly at our Community Forum or reach out to syside.support@sensmetry.com.

Important: Some functionality of Syside Modeler overlaps with Syside Editor. To avoid conflicts, uninstall or disable Syside Editor before using Modeler.

Features

The extension provides core features for SysML v2 modeling and textual editing:

Model visualization

Interactive tree view

Explore model structure through an interactive tree view that displays model elements and their relationships.

Export diagram

Export visualizations to multiple formats including PNG, SVG, and PDF.

Show source code

Jump directly from any diagram element to its corresponding definition in the text editor.

Navigate links

Trace relationships between elements by following connection paths through the diagram.

Search diagram

Locate elements quickly by searching for names, with matching results highlighted in the visualization.

Textual editing

Model validation

Catch errors early with real-time diagnostics for syntax errors, type mismatches, and constraint violations.

Semantic highlighting

Quickly identify element types and model structure through visual styling based on semantic meaning.

Model navigation

Navigate your model efficiently by jumping to definitions, finding references, and traversing specialization hierarchies across files.

Documentation on hover

Access element documentation, type information, and metadata instantly without leaving your current context.

Renaming

Rename elements safely across your entire workspace with automatic updates to all references.

Document outline

Navigate quickly to any element using a hierarchical tree view that provides structural overview of the currently opened document.

References

Understand the impact of changes by finding all locations where an element is referenced.

Folding

Improve readability by collapsing and expanding sections based on syntactic structure.

Auto-completion

Write SysML v2 code faster with context-aware suggestions for keywords, element names, and qualified references.

Auto-formatting

Maintain consistent code style with automatic indentation, spacing, and alignment.

Useful Resources

• Documentation: docs.sensmetry.com
• Website: sensmetry.com/syside
• Community Forum: forum.sensmetry.com
• Upcoming Features: Syside Roadmap

Developed by Sensmetry - Enabling Systems Integrated Digital Engineering to build superior systems much faster.