• Language: en

METHOD_OPTIONS

Type: dict_record

method options for popy_tutsum

Example:-

METHOD_OPTIONS:
    py_module: tutsum
    float_format: default

py_module

Type: one_of(tutsum)

Python module required to process this script file

Example:-

py_module: tutsum

float_format

Type: str

Format string for numerical output

Example:-

float_format: default

FILE_PATHS

Type: dict_record

file paths

Example:-

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']
    delete_old_files_flag: False

tut_script_path

Type: input_file

Path to tut_script.

Example:-

tut_script_path: tut_script.pyml

gensum_script_path

Type: input_file / none

Path to gensum_script.

Example:-

gensum_script_path: gensum_script.pyml

gensum_output_folder

Type: output_folder / none

gensum script output folder.

Example:-

gensum_output_folder: gensum_script.pyml_output

fitsum_script_path

Type: input_file / none

Path to fitsum_script.

Example:-

fitsum_script_path: fitsum_script.pyml

fitsum_output_folder

Type: output_folder / none

fitsum script output folder.

Example:-

fitsum_output_folder: fitsum_script.pyml_output

comp_script_path

Type: input_file / none

Path to comp_script.

Example:-

comp_script_path: comp_script.pyml

comp_output_folder

Type: output_folder / none

comp script output folder.

Example:-

comp_output_folder: comp_script.pyml_output

build_root

Type: output_folder / auto

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

Example:-

build_root: auto

output_folder

Type: output_folder / auto

Output folder - results of computation stored here

Example:-

output_folder: auto

log_folder

Type: output_folder / auto

Log folder - log files stored here

Example:-

log_folder: auto

output_file_ext

Type: list_of(pdf,png,svg)

Output file extension - determines graphical output file format.

Example:-

output_file_ext: ['svg']

delete_old_files_flag

Type: bool

Option to delete any existing files before running.

Example:-

delete_old_files_flag: False

OUTPUT_OPTIONS

Type: dict_record

Output options

Example:-

OUTPUT_OPTIONS:
    label: auto
    build_html: True

label

Type: str / auto

Label to give to the tutorial run.

Example:-

label: auto

build_html

Type: bool

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

Example:-

build_html: True
TutSum Script
N2PDat Script
Back to Top