The `sysml` command line¶

One binary is the whole toolchain: validator, analysis runner, interactive REPL, behavior engine, RDF exporter and document generator. The same runtime sits behind sysml-lsp for editors and sysml-grpc for programs. Pick a tab to see it work.

sysml — REPL

$ sysml -quiet -analysis DeltaVBudget::saturnIBAscent delta-v-budget.sysml
✓ package DeltaVBudget
✓ DeltaVBudget::saturnIBAscent
  stage1DeltaV = 3037.6966629706967 [SI::'m/s']
  stage2DeltaV = 6432.955324716369 [SI::'m/s']
  margin = 70.65198768706614 [SI::'m/s']
  objective reachesOrbit: satisfied
  standing: value (observed: 1 run under reverse)

$ sysml -quiet -analysis "DeltaVBudget::saturnIBAscent(required = 9800 ['m/s'])" delta-v-budget.sysml
✓ package DeltaVBudget
✗ DeltaVBudget::saturnIBAscent(required = 9800 ['m/s'])
  …
  margin = -329.34801231293386 [SI::'m/s']
  objective reachesOrbit: not satisfied: margin > 0 ['m/s']
  standing: value (observed: 1 run under reverse)

The runtime showcase, with this model

$ sysml -quiet -validate mass-rollup.sysml
✓ package MassRollup
✓ mass-rollup.sysml: no errors

$ sysml -quiet -e MassRollup::saturnVWithIU.totalMass mass-rollup.sysml
✓ package MassRollup
sysml: evaluation failed: feature value saturnVWithIU.totalMass: feature value InstrumentUnit.totalMass: no value for feature mass

$ sysml -quiet -calc "DeltaVBudget::InjectionDeltaV(3.986E14 [SI::N], 6563000 [SI::m], 384400000 [SI::m])" delta-v-budget.sysml
✓ package DeltaVBudget
sysml: calc invocation failed: calc DeltaVBudget::InjectionDeltaV: result: type mismatch: cannot write 3135.1638390999387 [kg**0.5/s] (dimension M^0.5·T^-1) to a feature typed by SpeedValue (dimension L·T^-1)
  standing: not covered (…)

Every one of these, reproduced

sysml> part def Wheel { attribute diameter = 16.0; }
✓ part def Wheel

sysml> %instantiate Wheel
✓ Created instance of Wheel
  ID: 1

sysml> %features Wheel
Instance: Wheel (ID: 1)
Features:
  diameter = 16.0
  …

sysml> calc add { in x; in y; x + y }
✓ calc add

sysml> %calc add 10 20
✓ add(10, 20)
  = 30
  standing: value (observed: 1 run under reverse)

The REPL, in the guide

$ sysml rover.sysml -render-document Hello::RoverReport
✓ package Hello
# Rover Parts

The rover's top-level parts, from the model:

<!-- caption -->
*Top-level parts*

| name |
| --- |
| arm |
| chassis |
| mast |

$ sysml rover.sysml -render-document Hello::RoverReport -doc-form html -o rover.html
✓ package Hello
wrote rover.html (html, 4983 bytes)   # or -doc-form pdf

The document generation manual

$ sysml -validate vehicles.sysml
vehicles.sysml:6:16: error: unresolved reference: Whel — did you mean Wheel?
        part spare : Whel;
                     ^~~~
sysml: vehicles.sysml did not analyse cleanly; no check was made

$ echo $?
2

$ sed -i 's/Whel/Wheel/' vehicles.sysml && sysml -validate vehicles.sysml
✓ package Vehicles
✓ vehicles.sysml: no errors

Checking a model, in the guide

sysml> state def TrafficLight {
  ...>     entry; then green;
  ...>     state green;  accept after 25 [SI::s] then yellow;
  ...>     state yellow; accept after 5 [SI::s] then red;
  ...>     state red;    accept after 30 [SI::s] then done;
  ...> }
✓ state def TrafficLight

sysml> %state TrafficLight
✓ Started state machine executor for "TrafficLight"
  Current state: green

sysml> %advance 25
✓ Advanced to 25.0 (1 event(s) processed)
  Current state: yellow

sysml> %advance 35
✓ Advanced to 60.0 (2 event(s) processed)
✓ State machine completed (a transition reached `done`)

Executing behavior, in the guide

$ sysml vehicles.sysml -convert ttl -o vehicles.ttl
note: RDF conversion is experimental: the mapping covers model structure and the behavior its bodies state, refuses what it cannot write back, …
wrote vehicles.ttl (ttl, 5562 bytes)
$ grep -A5 '^elmt:Vehicles__Wheel$' vehicles.ttl
elmt:Vehicles__Wheel
    a sysml:PartDefinition ;
    sysml:qualifiedName "Vehicles::Wheel" ;
    sysml:elementId "Vehicles__Wheel" ;
    sysx:memberIndex "1"^^xsd:integer ;
    sysml:owningNamespace elmt:Vehicles ;

$ sysml vehicles.ttl -convert sysml   # and back again
note: RDF conversion is experimental: …
package Vehicles {
    part def Wheel;
  …

$ sysml -query 'oslc.where=sysml:name="wheels"' vehicles.sysml
✓ package Vehicles
Vehicles::Car::wheels  PartUsage

Saving and RDF, in the guide

$ pip install opensysml
$ python
>>> import opensysml
>>> model = opensysml.load("vehicle.sysml")
>>> model.ok
True
>>> model.eval("mass", subject="Demo::sedan")
1800.0
>>> vehicle = model.get("Demo::Vehicle")
>>> vehicle.kind, vehicle.id
('partDef', 'Demo::Vehicle')
>>> built = model.instantiate("Demo::Vehicle")
>>> built.mass
1500.0

The clients, in the guide

Run it in your browser

This is the real sysml REPL, the same cmd/sysml you run in a terminal, built for WebAssembly with the production build tags and running entirely in this page. Nothing is sent to a server. Pick a walkthrough and press Run this step to type each command into the prompt, or type your own. Arrow keys bring back earlier lines, including those from your last visit, and Tab completes commands and names.

Loading the walkthroughs…

sysml — WebAssembly, in this page

$ sysml        # the full REPL, about 12 MB, downloaded once when you start it

sysml>

Running a walkthrough step starts the REPL too.

What the browser can't do: there is no disk, so %load and %save work on an in-memory filesystem that holds the showcase models under examples/runtime-showcase/ and is lost when the session ends. A page can't start other programs either, so %check, %solve, %configure, %optimize and %explain, which run an external SMT solver, report that the solver is unavailable. The production build also leaves out code generation, Flexo synchronization, SysML v1 migration, FMI and PDF rendering. Everything else in the REPL command reference runs here as it does in a terminal.

What it does¶

-analysis

Run analyses

Execute a model's analysis cases — evaluated features with units carried and checked, objectives decided against what the run finds. The delta-v budget above is the runtime showcase.

The command line

sysml>