ymmsl-dot 0.1.2

Visualise yMMSL models with graphviz.

yMMSL plotting tool

A tool to visualise yMMSL files using graphviz and ymmsl-python.

Examples

Two examples are shown here, a simple one macro_micro, and a more complex one complex.

Default

Explicit ports, simple arrows, legend (-p -s -l)

Usage (ymmsl graph --help)

Usage: ymmsl graph [OPTIONS] YMMSL_FILES...

  Plot a graphical representation of the passed yMMSL files.

  To help develop or understand about a coupled simulation it may be useful to
  view a graphical representation.

  If multiple yMMSL files are given, then they will be combined left to right,
  i.e. if there are conflicting declarations, the one from the file last given
  is used.

  Result:

    A graph is displayed or saved to disk, containing all the defined
    components and the connections between them.

  Examples:

    ymmsl graph simulation.ymmsl

Options:
  -o, --out FILE                  Output file (default ./output.format)
  -f, --fmt [canon|cmap|cmapx|cmapx_np|dia|dot|fig|gd|gd2|gif|hpgl|imap|imap_np|ismap|jpe|jpeg|jpg|mif|mp|pcl|pdf|pic|plain|plain-ext|png|ps|ps2|svg|svgz|vml|vmlz|vrml|vtx|wbmp|xdot|xlib]
                                  Set output format (default svg).
  -w, --viewer TEXT               Open with specified viewer (try xdg-open)
  -v, --verbose                   Show more info (prints the generated dot
                                  syntax)
  -p, --ports                     Explicitly draw component ports.
  -l, --legend                    Show a legend (only with --ports).
  -s, --simple-edges              Only indicate conduit direction, not port
                                  types.
  --portlabels                    Never simplify matching port labels along an
                                  edge.
  -h, --hide-edge-labels          Hide edge labels (as long as the input and
                                  output port match).
  --help                          Show this message and exit.

Issues and Discussions

As usual for any GitHub-based project, raise an issue if you find any bug or want to suggest an improvement, or open a discussion if you want to discuss.

Generated documentation

There is a docs/ folder containing sphinx documentation, but this has not yet been filled completely. Build it with

sphinx-build docs html