[adrpo]

Related Issues

Fixes #17408

Documents what these merged PRs added: #16954 (getClassDiagram, #16938), #16965 (OMEdit Class Diagram window), #17188 (getInstanceDiagram, #17181) and #17339 (getProbeTree/evaluateProbe, #17338) and #17360 (OMEdit Calibrate..., #17359).

Purpose

The User's Guide had none of these features. It also didn't show OMSimulator's Python API with its calibration section: omsimulator.rst still included three OMSimulator pages that no longer exist, which gave three include errors. The scripting API reference lists each function, but not what they are for or how to use them.

Approach

• New chapter umldiagrams.rst, UML Class and Instance Diagrams:
  • The two kinds of diagrams, the formats (PlantUML, Mermaid, draw.io) and the options of both functions.
  • Mermaid examples on a small Tanks package. omc generates them while the guide is built, so they always show the current output.
  • PlantUML renders of a redeclared medium (replaceable package, redeclaration and class extends), of Modelica.Blocks.Continuous.PID with showModifiers = false, and the instance diagram of ChuaCircuit.
• New chapter propertyprobes.rst, Property Probes and CodeProber:
  • What a property probe is, the probe tree with a real node of it, and the properties evaluateProbe computes.
  • evaluateProbe examples run on ProbeCircuit.mo while the guide is built.
  • How CodeProber uses the API, with three CodeProber screenshots and text probes as tests.
• omedit.rst: a new Class Diagram section: how to open the window, its controls and links, with two screenshots.
• omedit.rst: a new Calibrating an SSP Model section: the Calibrate... dialog and its fields, what it runs and writes, and the command line equivalent, with two screenshots. It links to OMSimulator's Parameter Calibration section for how the fit works.
• omsimulator.rst: includes the pages OMSimulator's own guide has: OMSimulatorPython3.rst instead of the removed OMSimulatorLua.rst, OMSimulatorPython.rst and SSP.rst, plus OMSimulatorGui.rst.
• Both chapters are in index.rst after the Modelica Language Server chapter.

getClassDiagram(Tanks.TwoTanks, fileName = "TwoTanks-class.mmd", format = "mermaid")
getInstanceDiagram(Tanks.TwoTanks, fileName = "TwoTanks-instance.mmd", format = "mermaid")
evaluateProbe("ProbeCircuit.mo", "0.0.5.4", "connectionEquations")

Testing

• Built the User's Guide HTML locally (usersguide target) against an install of current master. The whole guide builds without warnings (before: the three OMSimulator include errors), all 10 new images are included, and the calibration section links to OMSimulator's Parameter Calibration section. The examples above produced the shown results.
• The PlantUML sources of the redeclare and PID images were regenerated with current master and are identical to the ones the images were made from. ChuaCircuit was re-rendered from current output.
• The two calibration screenshots were taken in OMEdit built from current master: the Calibrate... menu entry and the dialog after calibrating the dc_motor SSP (3 FMUs, activity cal_01), with the same result as the command line (R = 0.0999684).
• The OMEdit screenshots are from the Class Diagram view PR ([OMEdit] Class Diagram view with links to the code (#4586, #16938) #16965). The window looks the same, except that it now has a tab per class.

An AI coding agent (Claude Code) wrote the text and selected and prepared the images; the local doc build above is the testing done.

---

Generated by Claude Code