This release is a pre-release and may not be stable for production use.
Syside Python Library & CLI
Syside comes as a Python library and a command-line tool, installed together. Both require a paid plan to use. It enables the revolutionary System-as-Code paradigm, providing machine-readability and programmatic access to your system models.
Syside CLI: validates models, generates and exports diagrams, exports grid views as CSV and moves requirements in and out of ReqIF.
Syside Python Library: enables you to generate reports, evaluate expressions, analyze and build custom tooling to extend your workflows into SysML v2.
Free 30-Day Trial: Get started with the Solo plan, which also covers the Syside VS Code Extension — cancel anytime.
Table of Contents
Key Features
Syside 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
- CLI - Validate SysML v2 models, generate diagrams, import/export requirements through ReqIF, use Syside in CI/CD.
See all
sysidecommands.
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 using pip:
pip install syside
License Activation
Syside requires a paid plan to run. Set your
license key in 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__)"
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 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
- CLI Commands: docs.sensmetry.com/python-lib/cli
- API Reference: docs.sensmetry.com/python
- Website: sensmetry.com/syside
- Community Forum: forum.sensmetry.com
- Upcoming Features: Syside Roadmap
Licensing Information
Syside is a paid-for and licensed product. Which agreement governs your use depends on the plan you are on, so see Licensing for the plans, their license types, and what governs each.
To acquire a license, visit the Syside plans page.
Copyright (c) 2025-2026 Sensmetry. All rights reserved.
Developed by Sensmetry - Enabling Systems Integrated Digital Engineering to build superior systems much faster.
Metadata
Release files for syside 1.0.0b1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Actions Reset | |||
|---|---|---|---|---|
| syside-1.0.0b1-cp312-abi3-win_arm64.whl | CPython 3.12 | abi3 | Windows ARM64 | Details for syside-1.0.0b1-cp312-abi3-win_arm64.whl |
| syside-1.0.0b1-cp312-abi3-win_amd64.whl | CPython 3.12 | abi3 | Windows x86-64 | Details for syside-1.0.0b1-cp312-abi3-win_amd64.whl |
| syside-1.0.0b1-cp312-abi3-manylinux_2_31_x86_64.whl | CPython 3.12 | abi3 | Linux glibc 2.31+ x86-64 | Details for syside-1.0.0b1-cp312-abi3-manylinux_2_31_x86_64.whl |
| syside-1.0.0b1-cp312-abi3-macosx_11_0_arm64.whl | CPython 3.12 | abi3 | macOS 11.0+ ARM64 | Details for syside-1.0.0b1-cp312-abi3-macosx_11_0_arm64.whl |
| syside-1.0.0b1-cp312-abi3-macosx_10_15_x86_64.whl | CPython 3.12 | abi3 | macOS 10.15+ x86-64 | Details for syside-1.0.0b1-cp312-abi3-macosx_10_15_x86_64.whl |
Total release size: 157.7 MB
Release files / syside-1.0.0b1-cp312-abi3-win_arm64.whl
| Download URL | syside-1.0.0b1-cp312-abi3-win_arm64.whl |
|---|---|
| Size | 29.8 MB |
| Tags | CPython 3.12 Windows ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
f0e7debe1aba89f4c28a114426350109762ed52e09bf388d4c1e90639359ec25
|
|
BLAKE2b-256 checksum How to use checksums |
697e318963c82d9337efb26e01c8eacf9fcd54b74fdaa0f2bf2a9433102bb081
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / syside-1.0.0b1-cp312-abi3-win_amd64.whl
| Download URL | syside-1.0.0b1-cp312-abi3-win_amd64.whl |
|---|---|
| Size | 31.8 MB |
| Tags | CPython 3.12 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
20c8d7effb71d5152674b6e501613f68ea93ce82bfcbf3e151a5ccdd40c8ec9e
|
|
BLAKE2b-256 checksum How to use checksums |
aa0531a2831e59e1a8d5c3bc7164410716d746b834a504c0639b5536c6038261
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / syside-1.0.0b1-cp312-abi3-manylinux_2_31_x86_64.whl
| Download URL | syside-1.0.0b1-cp312-abi3-manylinux_2_31_x86_64.whl |
|---|---|
| Size | 34.7 MB |
| Tags | CPython 3.12 Linux glibc 2.31+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
8c601e2dc4887cd1ac7c8d17dd00338591b3fee54b34cf690cf673327f9add9f
|
|
BLAKE2b-256 checksum How to use checksums |
c2ca578b647df15a1b5cf1e27403a6692fd43645d64580d2dc8c46d7344a2889
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / syside-1.0.0b1-cp312-abi3-macosx_11_0_arm64.whl
| Download URL | syside-1.0.0b1-cp312-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 29.4 MB |
| Tags | CPython 3.12 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
33da97733ced0c8175b7d3d91ed4582374df6d71ed0c3bee38924835d4d4c18c
|
|
BLAKE2b-256 checksum How to use checksums |
c9c7593827fbe15caf97ee5e03982ea03b9a5ab84ba2880a27363ade2229ce74
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / syside-1.0.0b1-cp312-abi3-macosx_10_15_x86_64.whl
| Download URL | syside-1.0.0b1-cp312-abi3-macosx_10_15_x86_64.whl |
|---|---|
| Size | 31.9 MB |
| Tags | CPython 3.12 abi3 macOS 10.15+ x86-64 |
|
SHA-256 checksum How to use checksums |
ffadf175cf74fdc0d8bd438b3c7347dfe0cfdc3df4276ddb50f387d07d7076b6
|
|
BLAKE2b-256 checksum How to use checksums |
475c9efd4cbe2631844341852e2b3b1cd706a89f2b564edde3bed0e8c2e77232
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Security for syside 1.0.0b1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.