• Language: en

METHOD_OPTIONS

Type: dict_record

method options for gensum

Example:-

METHOD_OPTIONS:
    py_module: gensum
    float_format: default

py_module

Type: one_of(gensum)

Python module required to process this script file

Example:-

py_module: gensum

float_format

Type: str

Format string for numerical output

Example:-

float_format: default

FILE_PATHS

Type: dict_record

file paths

Example:-

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

gen_script_path

Type: input_file

Path to original gen_script.

Example:-

gen_script_path: gen_script.pyml

gen_output_folder

Type: output_folder / none

gen output folder.

Example:-

gen_output_folder: gen_script.pyml_output

sim_script_path

Type: input_file / none

Path to original sim_script output by gen_script.

Example:-

sim_script_path: none

sim_output_folder

Type: output_folder / none

sim output folder.

Example:-

sim_output_folder: none

build_root

Type: output_folder / auto

Path to the root of the build tree

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
GenSum Script
TutSum Script
Back to Top