Python Library & CLI

Syside comes as a Python library and a command-line tool, published together on PyPI. One install brings both, and a virtual environment is the recommended place to put them. Both require a paid plan.

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.

Get started

1. Set up a virtual environment – Recommended to start installation here

2. Install the Python Library & CLI – One command to install both

Then take whichever first run matches your work:

• Your first CLI example – check a model, draw its diagrams and export a table, in one sitting

• Your first Python example – load a model from Python, walk it, and evaluate a requirement against it

Read more

How-to guides:

• Generate diagrams from CLI – Single elements, views and multi-file models, and regenerating them in a pipeline

• Find and navigate elements – Locate elements by type or name, and walk the hierarchy

• Evaluate attribute values – Compute the value an attribute’s expression gives it

Python Library:

• SysML Syntax Explorer – Explore SysML code structure interactively

• Query API – Ask questions about a model in one call each, check its asserted constraints, and test its rules with pytest

• Interactive mode – Drive the library from a command-driven interface

• Examples collection – Practical scripts to download and run right away

Explanation:

• Models as Python objects – What a loaded model hands your script: documents, elements, relationships

• Advanced technical guide – Information for power users and developers

CLI reference:

• All commands – Every command in one table

• Check command – Validate models for semantic errors and warnings

• Viz command – Generate diagrams from SysML v2 models

• Grid command – Generate CSV exports of grid views

• Format command – Format models according to a consistent style

• Rule command – Look up Syside validation rules

• Project command – Work with SysML v2 or KerML projects

• Version command – Display the installed version

• Help command – Print help for a command

• ReqIF – Exchange requirements with ReqIF-compliant tools, from the syside[reqif] extra

• Solver – Check assertions and explore attainable values across every interpretation of a model, from the syside[solver] extra

Reference for the syside package itself lives in the API reference.

Have questions?

• Visit our Forum