# METHOD_OPTIONS

Type: dict_record

method options for mcomp_script

Example:-

    METHOD_OPTIONS:
        py_module: mcomp
        rand_seed: 12345
        float_format: default

## py_module

Type: one_of(mcomp)

Python module required to process this script file

Example:-

    py_module: mcomp

## 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

# DESCRIPTION

Type: dict_record

Description fields for script.

Example:-

    DESCRIPTION:
        name: example
        title: A PKPD model
        author: J.R. Hartley
        abstract: |
        keywords: []

## name

Type: str

Unique name used to distinguish script

Example:-

    name: example

## title

Type: str

A longer text string that could serve as a title

Example:-

    title: A PKPD model

## author

Type: str

Author of the model

Example:-

    author: J.R. Hartley

## abstract

Type: verbatim

Abstract paragraph describing model

Example:-

    abstract: |

## keywords

Type: list

Keywords list used to categorise models.

Example:-

    keywords: []

# FILE_PATHS

Type: dict_record

File paths for mcomp script

Example:-

    FILE_PATHS:
        output_folder: auto
        temp_folder: auto
        log_folder: auto
        output_file_ext: ['svg']
        mgen_script_path: auto
        mgen_output_folder: auto
        mfit_script_path: auto
        mfit_output_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

## output_file_ext

Type: list_of(pdf,png,svg)

Output file extension - determines graphical output file format.

Example:-

    output_file_ext: ['svg']

## mgen_script_path

Type: input_file / auto

Path to mgen_script.

Example:-

    mgen_script_path: auto

## mgen_output_folder

Type: output_folder / auto

mgen_script output folder.

Example:-

    mgen_output_folder: auto

## mfit_script_path

Type: input_file / auto

Path to mfit_script.

Example:-

    mfit_script_path: auto

## mfit_output_folder

Type: output_folder / auto

mfit_script output folder.

Example:-

    mfit_output_folder: auto

# MCOMP_OPTIONS

Type: dict_record

Options for mcomp script

Example:-

    MCOMP_OPTIONS:
        dot_size: 12

## dot_size

Type: int

Size of dots appearing in scatter plots

Example:-

    dot_size: 12