Skip to content
ugeorge edited this page Mar 13, 2016 · 10 revisions

f2dot stands for ForSyDe-to-DOT graph. It started as an iternal project for the ForSyDe methodology, but evolved into a general XML-intermediate system representation to DOT graphs. At the time of writing this page, f2dot supported ForSyDe-SystemC and SDF3 intermediate XML representations.

Navigation

Here you can find more information if you are looking for:

Usage

The user has multiple possibilities to customize the output graph either through command-line argument or a config file.

The basic usage of the program is

f2dot <module.xml>

where <module.xml> is the top-level XML file. By default, f2dot assumes that the input file is a ForSyDe intermediate representation. Notice that the ForSyDe IR regards all composite processes as process networks on their own, thus any valid ForSyDe-XML generated file can be a top module. Also, take note that the tool assumes that all the XML files representing the child processes are in the same folder, as they were generated by the introspection.

In case the input file is not ForSyDe-IR, a parsing mode needs to be mentioned with argument -m. For example, to plot an SDF3 model, you need to run the command:

f2dot -m sdf3 <module.xml>

If no config file was mentioned (with argument -c), the component looks inside the parent directory of <module.xml> for <mode>.config. If it didn't find it, it generates a default <mode>.config file there, which be modified with custom plotting. The user is encouraged to read the documentation generated for each option.

For a list with all the command-line arguments, one needs to run the program followed by -h.

  • as standalone binary release:
f2dot -h
  • as script file:
python f2dot -h
Clone this wiki locally