documentation of integer values for dot-verbosity

[researcherben]

In prior versions of SST, the graphviz output included the link latency and the port name per component. Now when I use

sst --output-dot=$(CONFIG).gv --run-mode=init $(CONFIG).py 1 3

the graphviz content is simplified. The link latency and the port name are not included.
That's a reasonable design choice, but for the specific application I'm interested in I want to turn it back on.

The command

sst --help

shows the new option

--dot-verbosity=INT       amount of detail to include in the dot graph output

I'm not sure how to determine what the values of INT correspond to, so I first tried

sst --help --dot-verbosity

but that doesn't work.

Summary: For SST v11 there is a --dot-verbosity flag for the graphviz output and is currently no documentation

From speaking with a person familiar with the issue, the summary of the levels below

    Default level (0-1): Only displays component names and draws links between components
    level 2-3: displays component type
    level 4-5: displays subcomponents
    level 6-7: displays ports
    level 8-9: displays link name and latency
    level 10+: displays the MPI rank information for the partitioned graph

The point of the numbering is to leave room to add other verbosities.

I'm not clear where this documentation belongs.

The relevant file is cfgoutput/dotConfigOutput.cc in sst-core

From the page https://sst-simulator.org/SSTPages/SSTMainDocumentation/ I searched the release notes https://sst-simulator.org/SSTPages/SSTmicroRelease_V11dot0dot0/ but see no mention of dot-verbosity

I also tried https://sst-simulator.org/SSTDoxygen/11.0.0_docs/html/index.html but there's no search capability.

Next I tried searching the source code https://github.com/sstsimulator/sst-core/search?q=dot-verbosity and found a single file, https://github.com/sstsimulator/sst-core/blob/master/src/sst/core/config.cc#L141

There's only one instance, so maybe the relevant variable is setDotVerbosity which I then searched for https://github.com/sstsimulator/sst-core/search?q=setDotVerbosity

[jleidel]

Documented in https://github.com/jleidel/sst-documentation/tree/Level3Container/Tutorials
We will fork the upstream SST documentation into a new documentation portal.