Syside Automator

Syside Automator is a Python library that enables the analysis and optimization of SysML v2 models, automation of modeling workflows, and building custom applications. It utilizes the latest features of Python such as typing hints and generics making it easier to write correct Python code that queries and manipulates SysML v2 models.

Syside Automator enables the revolutionary System-as-Code paradigm, providing machine-readability and programmatic access to your system models.

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

Table of Contents

• Syside Automator
  • Table of Contents
  • Key Features
  • Quick Example
  • Getting Started
    • System Requirements
    • Installation
    • License Activation
  • Use Cases
  • Useful Resources
  • Licensing Information

Key Features

Syside Automator provides comprehensive capabilities for working with SysML v2 models programmatically:

• Model Loading & Analysis - Load and analyze SysML v2 (.sysml) files
• Element Extraction - Extract and display model elements, parts, attributes, and relationships
• Type Hierarchies - Navigate and work with part types, specializations, and hierarchies
• Documentation Extraction - Extract structured documentation from models
• JSON Import/Export - Convert models to and from JSON format for integration with other tools
• Model Creation - Programmatically create and modify SysML v2 models

Quick Example

import syside

# Load a SysML v2 model
model, _ = syside.load_model([r"path/to/model.sysml"])

# Extract all parts from the model
for part in model.elements(syside.PartUsage):
    print(f"Part: {part.name}")

Getting Started

System Requirements

• Operating System:
  • Windows 10+ x64 or arm64
  • macOS Big Sur (11.0+, arm64) or High Sierra (10.13+, x64)
  • x64 Linux distribution with glibc >= 2.31
• Python: 3.12 or newer

Installation

Install Syside Automator using pip:

pip install syside

License Activation

Syside Automator requires a license key to run. Set the SYSIDE_LICENSE_KEY environment variable:

# Windows (PowerShell)
$env:SYSIDE_LICENSE_KEY = "<your-license-key>"

# macOS / Linux
export SYSIDE_LICENSE_KEY=<your-license-key>

For other activation methods (.env file, system keyring, CI/CD setup), see the License Activation guide.

Verify Installation:

python -c "import syside; print(syside.__version__)"

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

Use Cases

Syside Automator enables powerful automation and analysis workflows:

• Automated Model Validation - Build custom validation rules and checks for your models
• Requirements Analysis - Extract, analyze, and trace requirements across large model bases
• Documentation Generation - Auto-generate technical documentation from your models
• Model Transformation - Convert between different model formats and representations
• Integration Pipelines - Integrate SysML v2 models into CI/CD workflows
• Custom Tooling - Build domain-specific tools and applications on top of your models
• Data Analytics - Perform quantitative analysis on model complexity, coverage, and metrics
• System-as-Code - Treat your system models as code with full programmatic control

Useful Resources

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

Licensing Information

Syside Automator is a paid-for and licensed product. By installing or using this software, you agree to the terms of the Syside License Agreement.

To purchase a license, visit the Syside pricing page or reach out to us at syside@sensmetry.com.

CI/CD Usage: Using Automator in CI/CD requires a Deployment License Key (available under the Business plan).

Copyright (c) 2025 Sensmetry. All rights reserved.

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