.. _files_generated_by_tutsum_script:

Files Generated by Tutsum Script
=================================
    
This section describes the output of the :ref:`tutsum_script`. If you want to see an example of a :ref:`tutsum_script` created by a :ref:`tut_script`, see :ref:`simple_tut_example`.
    
If you run a :ref:`tutsum_script` using the following command:-
    
.. code-block:: console

    popy run my_tutsum_script.pyml
    
folders will be created on disk (within the same folder as the script) as follows:-
    
.. code-block::
    
    build
    src
    my_tutsum_script.pyml.html
    my_tutsum_script.pyml.run.main.log
    sphinx.log

Here 'src' contains files copied from the output of the parent :ref:`tut_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::

    build/
        html/
            index.html

Here 'sphinx.log' is the log file for |sphinx| and 'my_tutsum_script.pyml.run.main.log' is the log file for the :ref:`tutsum_script`.

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

.. code-block:: console

    popy view my_tutsum_script.pyml.html
            
Which should look something like :ref:`sum_link_builtin_tut_example_tut`.
