Install Modeler

This guide will help you install Syside Modeler. It covers system requirements, installation steps, license activation, and updating.

Minimum Requirements

  • System requirements:

    • Windows 10+ x64 (for older versions, install Windows UCRT)

  • System requirements:

    • macOS Big Sur (11.0+, arm64)

    • macOS High Sierra (10.13+, x64)

  • System requirements:

    • Linux x64 distribution with GNU C Library glibc >= 2.31

    Note

    Some Linux distributions like Alpine and Chimera do not include glibc and may not support running applications that require it.

    How to check your glibc version

    1. Using gcc:

      $(cat $(gcc -print-file-name=libc.so) | grep -P '/[^\s]+/libc\.so\.[\w]+' -o)

      You should see output similar to: GNU C Library (GNU libc) stable release version 2.40

    2. Using Python:

      python -c "import platform; print(platform.platform())"

      You should see output similar to (glibc should be printed at the end): Linux-6.13.7-3-cachyos-x86_64-with-glibc2.41

  • Network connectivity:

    • Internet connection is required for installation, updates and usage

Note

Syside Modeler periodically validates license and collects basic usage data: launch time, and hashed machine ID (not personally identifiable).

Syside Modeler can be used offline for short periods of time, but a fully network-isolated solution requires an offline license available on the Business plan.

Install Extension

Warning

Syside Modeler shares some features with Syside Editor. To avoid conflicts, please uninstall/disable Syside Editor before using Syside Modeler.

For network-isolated or air-gapped environments, see Offline Installation page.

  1. Open Visual Studio Code

  2. Open Extensions view (click in left sidebar or press Ctrl/Cmd-Shift-X)

  3. In the search bar, type Syside Modeler

  4. Click Install on Syside Modeler by Sensmetry (identifier sensmetry.syside-modeler)

Extension can also be installed from Marketplace directly.

  1. Download Syside Modeler extension (may take a few seconds to start)

    Other platforms: Windows | macOS (Intel) | macOS (ARM) | Linux

  2. Open Visual Studio Code or your preferred VSCodium-based editor

  3. Open VSIX installation window:

    1. via Extensions view:

      1. Click in left sidebar or press Ctrl/Cmd-Shift-X

      2. Drag and drop the downloaded syside-modeler-*.vsix file to the Extensions panel (alternatively, click … and Install from VSIX…)

    2. via Command Palette:

      1. Open the Command Palette Ctrl/Cmd-Shift-P

      2. Type Extensions: Install from VSIX…

      3. Select downloaded syside-modeler-*.vsix file and click Install

Warning

Extensions installed from VSIX files do not receive automatic updates. To update Syside Modeler, see Update Modeler section.

Activate License

When first trying to use Syside Modeler you will be prompted to provide the license key. To trigger the prompt manually, follow these steps:

  1. Open any *.sysml SysML file

    • You should get a prompt next to Command Palette asking to enter Syside License Key.

Syside Modeler license dialog

  1. Enter Syside License Key and press Enter

    • If license activation succeeds, a confirmation message will appear:

    Syside Modeler license success

    • If license activation fails, an error message appears. Verify your license key and try again.

    If the issue persists, check Troubleshooting section for potential solutions.

  2. If you get a popup asking to install Syside Tools, click Install Syside Tools

    • If you did not get or dismissed the prompt, you can install Syside tools manually:

      1. Open the Command Palette Ctrl/Cmd-Shift-P

      2. Type Syside Modeler: Install Syside Tools

If you plan to use Modeler CLI or Automator outside your editor, you can add your license key to your Operating System’s secret storage:

  1. Open the Command Palette Ctrl/Cmd-Shift-P

  2. Type Syside Modeler: Add Syside license key to keyring

Verify Installation

Once Syside Modeler is installed and activated, follow these steps to quickly verify it is working as expected.

  1. Create a new SysML file named example.sysml with the following content:

    package 'Part Tree Example' {
   part def Electrical;

   part Automobile {
      part 'Drive Train' {
         part Battery : Electrical;
         part Motor : Electrical;
      }

      part Chassis {
         part Suspension : Mechanical;
         part Body : Mechanical;
      }
   }
}

  2. Open example.sysml file in your editor

    • You should immediately see highlighted syntax and two errors in the terminal. This is because Mechanical part definition is missing.

    Error - Missing part definition

  3. Correct the error by updating the example.sysml file:

    package 'Part Tree Example' {
   part def Electrical;
   part def Mechanical;

   part Automobile {
      part 'Drive Train' {
         part Battery : Electrical;
         part Motor : Electrical;
      }

      part Chassis {
         part Suspension : Mechanical;
         part Body : Mechanical;
      }
   }
}

    The errors should disappear.

  1. Visualize the model:

    1. Click on Syside logo (top right) and select Visualize current file

    2. Alternatively, use keyboard shortcut Ctrl/Cmd+Shift+V

Tip

Modeler may offer to install Python and Java versions. Follow the instructions on screen. Once installed, repeat Step 3.

Once loaded, you should see a diagram similar to this:

Visualization of the model given in the Setting up your project section

Update Modeler

By default, Visual Studio Code updates extensions automatically. You only need to reload the extension after the update completes.

If you are not receiving automatic updates:

  1. Open Extensions view (click in left sidebar or press Ctrl/Cmd-Shift-X)

  2. Find Syside Modeler in the list

  3. Verify the Auto Update checkbox is enabled

Extensions installed from VSIX files do not receive automatic updates.

To update to the latest version, repeat the Install Extension above to download and install the latest VSIX file.

Tip

Your license activation and settings will be preserved during the update.

What’s Next?

Now that Syside Modeler is installed and working, continue to learn more:

  • Check out the Essentials section to learn about visualization, navigation, and core modeling features

  • Check out the Configure Modeler section and configure Modeler for your use case

  • Check out the Modeler CLI section to learn about using Modeler CLI

  • Explore Automator to learn about automation and scripting features