OpenSysML documentation¶
Using it¶
The guide — a handbook, in reading order: install, your first model, the command line, the REPL, checks, behavior, saving and RDF, editors, Python, troubleshooting.
Runnable models are in examples/, with a catalog of what each one shows.
Looking one thing up¶
- 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-lspserves a diagram client - Environment variables — the bounds one run may spend, and paths
- Go API — the public API of every package
- Python API —
opensysml, its generated typed classes and latency - RDF mapping — which triples a model becomes, what is not mapped, and why the mapping is experimental
- Grammar — grammar production → parser implementation
How it works¶
- Architecture — the pipeline, the tiers, the test contracts
- Testing — the test contracts each kind of change must satisfy
- Performance — profiling, and what a large model costs
- Design notes and plans — for maintainers
Where the project stands¶
- Spec compliance — faithful, approximate, or not implemented
- Training examples — the OMG corpus, 100/100 clean
- Pilot differential — our diagnostics against the OMG pilot implementation
- Grammar coverage — which OMG grammar productions our inputs exercise
- Roadmap — the known gaps, in the order they should be picked up
- Releasing — the pre-tag gate, tagging, artifacts, Homebrew
- macOS distribution — Gatekeeper and the signing decision
- Demo — a scripted walkthrough of the whole surface
Contributing, including where a new page belongs, is CONTRIBUTING.md.