# METHOD_OPTIONS

Type: dict_record

method options for sumdoc_script

Example:-

    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

## py_module

Type: one_of(sumdoc)

Python module required to process this script file

Example:-

    py_module: sumdoc

## rand_seed

Type: int / auto

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

Example:-

    rand_seed: 12345

## float_format

Type: str

Format string for numerical output

Example:-

    float_format: default

## input_root

Type: input_folder

Root folder for input files

Example:-

    input_root: .

## output_root

Type: output_folder

Root folder for output files

Example:-

    output_root: .

## format_scripts

Type: bool

Flag to format scripts before running.

Example:-

    format_scripts: False

## copy_over_orig_with_formatted

Type: bool

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

Example:-

    copy_over_orig_with_formatted: False

## run_scripts

Type: bool

Flag to run scripts.

Example:-

    run_scripts: True

## copy_to_doc

Type: bool

Flag to copy rst to doc folder.

Example:-

    copy_to_doc: True

## create_link_files

Type: bool

Flag to create link file.

Example:-

    create_link_files: False

## script_log_level

Type: one_of(debug,info,warning,error,critical,notset)

Log level for individual scripts run scripts.

Example:-

    script_log_level: error

# FILE_PATHS

Type: dict_record

file paths for fit_script

Example:-

    FILE_PATHS:
        output_folder: auto
        temp_folder: auto
        log_folder: auto

## output_folder

Type: output_folder / auto

Output folder - results of computation stored here

Example:-

    output_folder: auto

## temp_folder

Type: output_folder / auto

Temp folder - temporary files stored here

Example:-

    temp_folder: auto

## log_folder

Type: output_folder / auto

Log folder - log files stored here

Example:-

    log_folder: auto

# SCRIPTS

Type: repeat_dict_record

Dictionary of script folders and parameters.

Example:-

    SCRIPTS: {}

## script_path

Type: input_file

Pyml tutorial script to generate summary doc.

Example:-

    script_path: .

## output_folder

Type: str

Folder where summary will be output by script.

Example:-

    output_folder:

## doc_folder

Type: str

Folder where summary doc will be copied to within doc.

Example:-

    doc_folder:

## title

Type: str

Title of the example

Example:-

    title: My Script

## description

Type: str

Description of the example

Example:-

    description: An example script.

## script_type

Type: one_of(tut,gen,fit,mtut)

Program used to run the script

Example:-

    script_type: tut