docs

OpenSysML documentation

Using OpenSysML

The guide — a handbook, in reading order: install, your first model, the command line, the REPL, checks, behavior, saving and RDF, editors, from your own program, troubleshooting.

Runnable models live in examples/, with a catalog describing what each one demonstrates.

Document generation manual — how to generate documents from your models using the built-in document queries: concepts, getting started, a query cookbook, document authoring, outputs (Markdown, HTML and PDF), interfaces, a complete worked example and limitations and troubleshooting.

Reference

• CLI — every sysml flag, the modes, and the exit codes
• REPL commands — every % command and its arguments
• LSP extensions — the custom render requests sysml-lsp offers diagram clients
• Environment variables — resource limits for a single run, and file paths
• Client libraries — the Go, Python, Node, Java and Rust libraries, and how to choose between them
• Go packages — client/opensysml and the packages behind it, type by type
• Python API — the opensysml package, its generated typed classes, and what calls cost
• Service transports — what sysml-grpc serves on its single port, and what happens when a capability is missing
• RDF mapping — the triples a model becomes, which constructs are not mapped, and why the mapping is experimental
• Grammar — how grammar productions map to the parser

Internals

• Architecture — the pipeline, the validation tiers, and the test contracts
• Testing — the tests each kind of change must satisfy
• Performance — profiling, and what a large model costs
• Design notes and plans — maintainer material

Project status

• Spec compliance — each rule marked faithful, approximate or not implemented
• Training examples — the OMG corpus, 100/100 clean
• Pilot corpora gate — OpenSysML's diagnostics on the three pinned OMG pilot corpora, with CI preventing regressions
• Pilot differential — OpenSysML's diagnostics compared against the OMG pilot implementation's
• Grammar coverage — which OMG grammar productions the project's inputs exercise
• Roadmap — the known gaps, in the order we plan to address them
• Releasing — the pre-tag gate, tagging, artifacts and Homebrew
• macOS distribution — Gatekeeper and the signing decision
• Demo — a scripted walkthrough of the full surface

For contribution guidance, including where a new page belongs, see CONTRIBUTING.md.