.. _files_generated_by_gensum_script:

Files Generated by Gensum Script
=================================
    
This section discusses how the :ref:`gensum_script` saves files to disk, if you want to see an example of a :ref:`gensum_script` created by a :ref:`gen_script`, see :ref:`builtin_gen_example`.
    
If you run a :ref:`gensum_script` using the following command:-
    
.. code-block:: console

    $ popy_run my_gensum_script.pyml
    
folders will be created on disk (within the same folder as the script) as follows:-
    
.. code-block:: console
    
    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 :ref:`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:-

.. code-block:: console

    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 :ref:`gensum_script`.

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

.. code-block:: console

    $ popy_view my_gensum_script.pyml.html
            
Which should look something like :ref:`sum_link_builtin_gen_example_gen`.
