Skip to content

README.md

Latest commit

 

History

History
41 lines (39 loc) · 3.02 KB

README.md

File metadata and controls

41 lines (39 loc) · 3.02 KB
Raw

Reference

Lookup documentation: every flag, command, symbol and triple, without the surrounding explanation. The guide covers the same material in reading order.

  • CLI — every flag of sysml, the modes, and the exit status
  • REPL commands — every % command and its arguments
  • LSP extensions — the custom render requests sysml-lsp serves to a diagram client
  • Jupyter kernel — sysml-jupyter-kernel, its kernelspec, what it reports and renders, and how the package installs it
  • Diagnostics: lints — the codes of the advisory lints, what each reports and how each surface switches one off
  • Environment variables — the resource limits for a single run, and paths
  • External engines — the OPENSYSML_ENGINES manifest entry, the protocol an engine speaks over its standard input and its JSON Schema, the sources and graphs:1 model forms, what stands of an engine's answer and how each failure is reported
  • Client libraries — the seven ways to reach the engine from a program, what each covers, and how to choose between them
  • Go packages — client/opensysml and the packages behind it, type by type
  • Python API — opensysml, its generated typed classes and latency
  • Node API — @openmbee/opensysml, its two entry points and its typed unions
  • Java API — opensysml, its immutable records and its exceptions
  • Rust API — the opensysml crate, blocking, and its one error enum
  • Julia API — the OpenSysML package, Connect-JSON over HTTP.jl
  • MATLAB API — the +opensysml package, for MATLAB and GNU Octave
  • Service transports — what sysml-grpc serves on one port, which body encoding a client should choose, and the flags for CORS, TLS and health
  • Wire contract — Connect + JSON field by field, for a MATLAB, R, Julia, C or shell client with no generated library: the session, every Value arm, errors, answers
  • RDF mapping — which triples a model becomes, what is not mapped, and why the mapping is experimental
  • SysML v1 migration — reading OMG UML/SysML XMI, Eclipse .uml and .mdzip, what each v1 construct becomes, and the migration report
  • FMI models — importing a .fmu as a calc def and the FMI runner that evaluates it
  • Compact API JSON — the api-json-compact/1 form and how it maps to the API element array
  • OSLC Query text — element-identification query syntax and semantics
  • Grammar — how each grammar production maps to the parser
  • WebAssembly builds — the two targets, how to build and run them, what works, and what a WebAssembly host refuses with