:orphan:

.. The content of this file was generated
.. automatically by the popy.conf.fio.rstdoc_writer module


.. _gensum_spec:



.. _gensum-method_options_spec:

METHOD_OPTIONS
**************

Type: :term:`dict_record <dict_record>`

method options for gensum

Example:-

.. code-block:: pyml

    METHOD_OPTIONS:
        py_module: gensum


.. _gensum-method_options-py_module_spec:

py_module
=========

Type: :term:`one_of(gensum) <one_of>`

Python module required to process this script file

Example:-

.. code-block:: pyml

    py_module: gensum


.. _gensum-file_paths_spec:

FILE_PATHS
**********

Type: :term:`dict_record <dict_record>`

file paths

Example:-

.. code-block:: pyml

    FILE_PATHS:
        gen_script_path: gen_script.pyml
        gen_output_folder: gen_script.pyml_output
        sim_script_path: none
        sim_output_folder: none
        build_root: auto
        output_folder: auto
        log_folder: auto
        output_file_ext: ['svg']


.. _gensum-file_paths-gen_script_path_spec:

gen_script_path
===============

Type: :term:`input_file <input_file>`

Path to original gen_script.

Example:-

.. code-block:: pyml

    gen_script_path: gen_script.pyml


.. _gensum-file_paths-gen_output_folder_spec:

gen_output_folder
=================

Type: :term:`output_folder <output_folder>` / :term:`none <none>`

gen output folder.

Example:-

.. code-block:: pyml

    gen_output_folder: gen_script.pyml_output


.. _gensum-file_paths-sim_script_path_spec:

sim_script_path
===============

Type: :term:`input_file <input_file>` / :term:`none <none>`

Path to original sim_script output by gen_script.

Example:-

.. code-block:: pyml

    sim_script_path: none


.. _gensum-file_paths-sim_output_folder_spec:

sim_output_folder
=================

Type: :term:`output_folder <output_folder>` / :term:`none <none>`

sim output folder.

Example:-

.. code-block:: pyml

    sim_output_folder: none


.. _gensum-file_paths-build_root_spec:

build_root
==========

Type: :term:`output_folder <output_folder>` / :term:`auto <auto>`

Path to the root of the build tree

Example:-

.. code-block:: pyml

    build_root: auto


.. _gensum-file_paths-output_folder_spec:

output_folder
=============

Type: :term:`output_folder <output_folder>` / :term:`auto <auto>`

Output folder - results of computation stored here

Example:-

.. code-block:: pyml

    output_folder: auto


.. _gensum-file_paths-log_folder_spec:

log_folder
==========

Type: :term:`output_folder <output_folder>` / :term:`auto <auto>`

Log folder - log files stored here

Example:-

.. code-block:: pyml

    log_folder: auto


.. _gensum-file_paths-output_file_ext_spec:

output_file_ext
===============

Type: :term:`list_of(pdf,png,svg) <list_of>`

Output file extension - determines graphical output file format.

Example:-

.. code-block:: pyml

    output_file_ext: ['svg']


.. _gensum-output_options_spec:

OUTPUT_OPTIONS
**************

Type: :term:`dict_record <dict_record>`

Output options

Example:-

.. code-block:: pyml

    OUTPUT_OPTIONS:
        label: auto
        build_html: True


.. _gensum-output_options-label_spec:

label
=====

Type: :term:`str <str>` / :term:`auto <auto>`

Label to give to the tutorial run.

Example:-

.. code-block:: pyml

    label: auto


.. _gensum-output_options-build_html_spec:

build_html
==========

Type: :term:`bool <bool>`

Whether or not to build the html from the generated source.

Example:-

.. code-block:: pyml

    build_html: True



