Skip to content

Latest commit

 

History

History

The OpenSysML guide

Read the chapters in order the first time through; each one builds on the ones before it.

  1. Install — a release build, Homebrew, or from source
  2. Your first model — declare, instantiate, evaluate
  3. From the command line — checking a file, exit status, scripting
  4. The REPL — the session model and the meta-commands
  5. Expressions, calculations, constraints and requirements — what a model asserts, and how to check it
  6. Behavior: actions and state machines — running and debugging behavior
  7. Saving, and converting to RDF — %save, -convert, round trips
  8. Editors — sysml-lsp and the VS Code extension
  9. From your own program — the Go, Python, Node, Java and Rust clients
  10. Troubleshooting — diagnosing a run that stops early
  11. Migrating a SysML v1 model — -convert from XMI, reading the report, finishing by hand

One topic stands on its own once the chapters are read: Modeling fleets and repeated structure — one definition with a multiplicity, variants with occurrence counts, per-occurrence values, and what a fleet of 12 800 occurrences costs to validate and to check.

Chapter 9 does one task in all five clients side by side — Go, Python, Node/TypeScript, Java and Rust, in tabs — and then has a section per client for what only that one has. Client libraries explains which to choose and what each covers.

If you want to look up a specific detail rather than read through, the reference covers the CLI flags, the REPL commands, the environment variables, the service API, the client libraries, each client's API and the RDF mapping.