:orphan:

.. The content of this file was generated
.. automatically by the popy.conf.fio.rstdoc_writer module
.. at 09 Mar 2022, 08:35:58


.. _sumdoc_spec:



.. _sumdoc-method_options_spec:

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

Type: :term:`dict_record <dict_record>`

method options for sumdoc_script

Example:-

.. code-block:: pyml

    METHOD_OPTIONS:
        py_module: sumdoc
        rand_seed: 12345
        float_format: default
        input_root: .
        output_root: .
        format_scripts: False
        copy_over_orig_with_formatted: False
        run_scripts: True
        copy_to_doc: True
        create_link_files: False
        script_log_level: error


.. _sumdoc-method_options-py_module_spec:

py_module
=========

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

Python module required to process this script file

Example:-

.. code-block:: pyml

    py_module: sumdoc


.. _sumdoc-method_options-rand_seed_spec:

rand_seed
=========

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

Option to set seed to make run result
reproducible -e.g. when debugging.

Example:-

.. code-block:: pyml

    rand_seed: 12345


.. _sumdoc-method_options-float_format_spec:

float_format
============

Type: :term:`str <str>`

Format string for numerical output

Example:-

.. code-block:: pyml

    float_format: default


.. _sumdoc-method_options-input_root_spec:

input_root
==========

Type: :term:`input_folder <input_folder>`

Root folder for input files

Example:-

.. code-block:: pyml

    input_root: .


.. _sumdoc-method_options-output_root_spec:

output_root
===========

Type: :term:`output_folder <output_folder>`

Root folder for output files

Example:-

.. code-block:: pyml

    output_root: .


.. _sumdoc-method_options-format_scripts_spec:

format_scripts
==============

Type: :term:`bool <bool>`

Flag to format scripts before running.

Example:-

.. code-block:: pyml

    format_scripts: False


.. _sumdoc-method_options-copy_over_orig_with_formatted_spec:

copy_over_orig_with_formatted
=============================

Type: :term:`bool <bool>`

Flag to copy formatted scripts over original and remove log files etc.

Example:-

.. code-block:: pyml

    copy_over_orig_with_formatted: False


.. _sumdoc-method_options-run_scripts_spec:

run_scripts
===========

Type: :term:`bool <bool>`

Flag to run scripts.

Example:-

.. code-block:: pyml

    run_scripts: True


.. _sumdoc-method_options-copy_to_doc_spec:

copy_to_doc
===========

Type: :term:`bool <bool>`

Flag to copy rst to doc folder.

Example:-

.. code-block:: pyml

    copy_to_doc: True


.. _sumdoc-method_options-create_link_files_spec:

create_link_files
=================

Type: :term:`bool <bool>`

Flag to create link file.

Example:-

.. code-block:: pyml

    create_link_files: False


.. _sumdoc-method_options-script_log_level_spec:

script_log_level
================

Type: :term:`one_of(debug,info,warning,error,critical,notset) <one_of>`

Log level for individual scripts run scripts.

Example:-

.. code-block:: pyml

    script_log_level: error


.. _sumdoc-file_paths_spec:

FILE_PATHS
**********

Type: :term:`dict_record <dict_record>`

file paths for fit_script

Example:-

.. code-block:: pyml

    FILE_PATHS:
        output_folder: auto
        temp_folder: auto
        log_folder: auto


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


.. _sumdoc-file_paths-temp_folder_spec:

temp_folder
===========

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

Temp folder - temporary files stored here

Example:-

.. code-block:: pyml

    temp_folder: auto


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


.. _sumdoc-scripts_spec:

SCRIPTS
*******

Type: :term:`repeat_dict_record <repeat_dict_record>`

Dictionary of script folders and parameters.

Example:-

.. code-block:: pyml

    SCRIPTS: {}


.. _sumdoc-scripts-script_path_spec:

script_path
===========

Type: :term:`input_file <input_file>`

Pyml tutorial script to generate summary doc.

Example:-

.. code-block:: pyml

    script_path: .


.. _sumdoc-scripts-output_folder_spec:

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

Type: :term:`str <str>`

Folder where summary will be output by script.

Example:-

.. code-block:: pyml

    output_folder:


.. _sumdoc-scripts-doc_folder_spec:

doc_folder
==========

Type: :term:`str <str>`

Folder where summary doc will be copied to within doc.

Example:-

.. code-block:: pyml

    doc_folder:


.. _sumdoc-scripts-title_spec:

title
=====

Type: :term:`str <str>`

Title of the example

Example:-

.. code-block:: pyml

    title: My Script


.. _sumdoc-scripts-description_spec:

description
===========

Type: :term:`str <str>`

Description of the example

Example:-

.. code-block:: pyml

    description: An example script.


.. _sumdoc-scripts-script_type_spec:

script_type
===========

Type: :term:`one_of(tut,gen,fit,mtut) <one_of>`

Program used to run the script

Example:-

.. code-block:: pyml

    script_type: tut



