Skip to content

The OpenSysML guide

Read in order the first time; each chapter assumes 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
  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 Python — the opensysml client over sysml-grpc
  10. Troubleshooting — when a run stops short

Looking up one thing rather than reading? The reference has the CLI flags, the REPL commands, the environment variables, the service API, the Python API and the RDF mapping.