Installation

This guide will help you install SysIDE Modeler. It covers system requirements, installation steps, license activation, and updating. Internet connection is required for the installation process.

Minimal Requirements

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

  • macOS Big Sur (11.0+, arm64) or High Sierra (10.13+, x64)

  • x64 Linux distribution with glibc >= 2.31

    Note

    Some Linux distributions like Alpine and Chimera do not include glibc and may not support ways of running applications requiring it.

    Tip

    Check your glibc version by running

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

    in the terminal. You should see an output starting with GNU C Library (GNU libc) stable release version 2.40. or similar.

    Alternatively, if python is installed, run

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

    You should see output similar to Linux-6.13.7-3-cachyos-x86_64-with-glibc2.41. If your system has glibc it should be printed at the end.

Installation

There are two ways of installing SysIDE Modeler: using the VS Code Marketplace or manually. Installing from the VS Code Marketplace is the recommended way to install SysIDE Modeler because it will automatically update the extension when a new version is released. However, if you want to install SysIDE Modeler into a VS Code compatible editor that does not support the VS Code Marketplace (for example, VSCodium) or you are inside an air-gapped environment, you need to use the manual installation method.

Installation steps:

  1. Open VS Code.

  2. Go to the Extensions view. You can do this in one of many ways:

    • Click on the Extensions icon in the Activity Bar on the left.

    • Keyboard shortcut: Ctrl-Shift-X for Windows/Linux, Command-Shift-X for MacOS.

    • Command palette: Ctrl-Shift-P for Windows/Linux, Command-Shift-P for MacOS and type Extensions: Focus on Extensions View.

  3. In the search bar, type SysIDE Modeler.

  4. Click Install on the SysIDE Modeler extension, making sure it is developed by Sensmetry.

  5. After the extension is installed, install the SysIDE tools by opening the command palette (Ctrl-Shift-P for Windows/Linux, Command-Shift-P for MacOS) and typing SysIDE Modeler: Install SysIDE Tools. The installation will prompt you to enter your license key.

To download SysIDE Modeler file, please select your platform, enter your SYSIDE_LICENSE_KEY, and click on the Download button. (Note: it will take a few seconds for the download to start.)

Once the download is complete, open VS Code (or an equivalent editor), open the Command Palette (Ctrl+Shift+P for Windows/Linux, Cmd+Shift+P for MacOS), and select Extensions: Install from VSIX. Once the pop up is open, simply select the downloaded file and click Install.

License Activation

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 command prompt (Ctrl+Shift+P for Windows/Linux, Cmd+Shift+P for MacOS) and execute command “SysIDE Modeler: Check SysIDE Modeler License”.

    SysIDE Modeler license command

  2. Insert your license key in the dialog that appears:

    SysIDE Modeler license dialog

  3. If the license is activated successfully, you should see the following output:

    SysIDE Modeler license success

After successfully entering the license key, it is stored in VS Code’s secret store and you will not be asked to provide a license key unless the license expires.

Verify Installation

  1. In VS Code, create a new file named example.sysml

  2. Input the following sample model into the 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;
      }
   }
}

  3. When example.sysml file is open and selected, visualize the model by:

    • Clicking the SysIDE logo in the top right and selecting Visualize current file

    • Using Ctrl+Shift+V (Windows/Linux) or Cmd+Shift+V (MacOS)

Note

If Modeler cannot find compatible Python and Java versions, it will offer to install them for you. Doing so will require repeating the above step to restart the visualization process.

  1. The visualization will load and display a diagram similar to this:

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

Once everything is working, you can proceed to Essentials to learn about SysIDE Modeler’s main features.

Updating

To update Modeler, simply repeat the installation steps to download and install the latest version.