Install Editor

This guide will help you install Syside Editor. It covers system requirements, installation steps, 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 Editor periodically validates license and collects basic usage data: launch time, and hashed machine ID (not personally identifiable).

Syside Editor 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

  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 Editor

  4. Click Install on Syside Editor by Sensmetry (identifier sensmetry.syside-editor)

Extension can also be installed from Marketplace directly.

  1. Download Syside Editor extension from Open-VSX Marketplace for your platform

  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 sensmetry.syside-editor-*.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 sensmetry.syside-editor-*.vsix file and click Install

Warning

Extensions installed from VSIX files do not receive automatic updates. To update Syside Editor, you will need to manually download the latest VSIX file and reinstall it following the same installation steps.

Verify Installation

Once Syside Editor is installed, 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.

Update Editor

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 Editor 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 settings will be preserved during the update.

What’s Next?

After successfully installing Syside Editor, continue to the following pages to learn more:

  • Check out the Essentials section to learn about available features

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

  • Check out the Tips and Tricks section for improving your workflows and working environment