:orphan:

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


.. _tutsum_spec:



.. _tutsum-method_options_spec:

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

Type: :term:`dict_record <dict_record>`

method options for popy_tutsum

Example:-

.. code-block:: pyml

    METHOD_OPTIONS:
        py_module: tutsum


.. _tutsum-method_options-py_module_spec:

py_module
=========

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

Python module required to process this script file

Example:-

.. code-block:: pyml

    py_module: tutsum


.. _tutsum-file_paths_spec:

FILE_PATHS
**********

Type: :term:`dict_record <dict_record>`

file paths

Example:-

.. code-block:: pyml

    FILE_PATHS:
        tut_script_path: tut_script.pyml
        gensum_script_path: gensum_script.pyml
        gensum_output_folder: gensum_script.pyml_output
        fitsum_script_path: fitsum_script.pyml
        fitsum_output_folder: fitsum_script.pyml_output
        comp_script_path: comp_script.pyml
        comp_output_folder: comp_script.pyml_output
        build_root: auto
        output_folder: auto
        log_folder: auto
        output_file_ext: ['svg']


.. _tutsum-file_paths-tut_script_path_spec:

tut_script_path
===============

Type: :term:`input_file <input_file>`

Path to tut_script.

Example:-

.. code-block:: pyml

    tut_script_path: tut_script.pyml


.. _tutsum-file_paths-gensum_script_path_spec:

gensum_script_path
==================

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

Path to gensum_script.

Example:-

.. code-block:: pyml

    gensum_script_path: gensum_script.pyml


.. _tutsum-file_paths-gensum_output_folder_spec:

gensum_output_folder
====================

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

gensum script output folder.

Example:-

.. code-block:: pyml

    gensum_output_folder: gensum_script.pyml_output


.. _tutsum-file_paths-fitsum_script_path_spec:

fitsum_script_path
==================

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

Path to fitsum_script.

Example:-

.. code-block:: pyml

    fitsum_script_path: fitsum_script.pyml


.. _tutsum-file_paths-fitsum_output_folder_spec:

fitsum_output_folder
====================

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

fitsum script output folder.

Example:-

.. code-block:: pyml

    fitsum_output_folder: fitsum_script.pyml_output


.. _tutsum-file_paths-comp_script_path_spec:

comp_script_path
================

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

Path to comp_script.

Example:-

.. code-block:: pyml

    comp_script_path: comp_script.pyml


.. _tutsum-file_paths-comp_output_folder_spec:

comp_output_folder
==================

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

comp script output folder.

Example:-

.. code-block:: pyml

    comp_output_folder: comp_script.pyml_output


.. _tutsum-file_paths-build_root_spec:

build_root
==========

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

Path to the root of the build tree (default: 'auto')

Example:-

.. code-block:: pyml

    build_root: auto


.. _tutsum-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


.. _tutsum-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


.. _tutsum-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']


.. _tutsum-output_options_spec:

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

Type: :term:`dict_record <dict_record>`

Output options

Example:-

.. code-block:: pyml

    OUTPUT_OPTIONS:
        label: auto
        build_html: True


.. _tutsum-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


.. _tutsum-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



