Files Generated by Gensum Script

This section discusses how the GenSum Script saves files to disk, if you want to see an example of a GenSum Script created by a Gen Script, see builtin_gen_example.

If you run a GenSum Script using the following command:-

popy run my_gensum_script.pyml

folders will be created on disk (within the same folder as the script) as follows:-

build
src
my_gensum_script.pyml.html
my_gensum_script.pyml.run.main.log
sphinx.log

Here ‘src’ contains files copied from the output of the parent Gen Script and some automatically generated .rst files.

The ‘build’ folder is the output of running Sphinx on the ‘src’ files. Sphinx is a utility for processing .rst files into HTML and optionally other formats. The main output of running sphinx is here:-

build/
    html/
        index.html

Here ‘sphinx.log’ is the log file for Sphinx and ‘my_gensum_script.pyml.run.main.log’ is the log file for the GenSum Script.

You can view the summary of the gen/sim output to HTML files by typing:-

popy view my_gensum_script.pyml.html

Which should look something like sum_link_builtin_gen_example_gen.