:orphan:

.. The content of this file was generated
.. automatically by the popy.conf.fio.rstdoc_writer module


.. _mcomp_spec:



.. _mcomp-method_options_spec:

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

Type: :term:`dict_record <dict_record>`

method options for mcomp_script

Example:-

.. code-block:: pyml

    METHOD_OPTIONS:
        py_module: mcomp
        rand_seed: 12345
        float_format: default


.. _mcomp-method_options-py_module_spec:

py_module
=========

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

Python module required to process this script file

Example:-

.. code-block:: pyml

    py_module: mcomp


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


.. _mcomp-method_options-float_format_spec:

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

Type: :term:`str <str>`

Format string for numerical output

Example:-

.. code-block:: pyml

    float_format: default


.. _mcomp-description_spec:

DESCRIPTION
***********

Type: :term:`dict_record <dict_record>`

Description fields for script.

Example:-

.. code-block:: pyml

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


.. _mcomp-description-name_spec:

name
====

Type: :term:`str <str>`

Unique name used to distinguish script

Example:-

.. code-block:: pyml

    name: example


.. _mcomp-description-title_spec:

title
=====

Type: :term:`str <str>`

A longer text string that could serve as a title

Example:-

.. code-block:: pyml

    title: A PKPD model


.. _mcomp-description-author_spec:

author
======

Type: :term:`str <str>`

Author of the model

Example:-

.. code-block:: pyml

    author: J.R. Hartley


.. _mcomp-description-abstract_spec:

abstract
========

Type: :term:`verbatim <verbatim>`

Abstract paragraph describing model

Example:-

.. code-block:: pyml

    abstract: |


.. _mcomp-description-keywords_spec:

keywords
========

Type: :term:`list <list>`

Keywords list used to categorise models.

Example:-

.. code-block:: pyml

    keywords: []


.. _mcomp-file_paths_spec:

FILE_PATHS
**********

Type: :term:`dict_record <dict_record>`

File paths for mcomp script

Example:-

.. code-block:: pyml

    FILE_PATHS:
        output_folder: auto
        temp_folder: auto
        output_file_ext: ['svg']
        mgen_script_path: auto
        mgen_output_folder: auto
        mfit_script_path: auto
        mfit_output_folder: auto


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


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


.. _mcomp-file_paths-output_file_ext_spec:

output_file_ext
===============

Type: :term:`list_of(pdf,png,svg) <list_of>`

Output file extension - determines graphical output file format.

Example:-

.. code-block:: pyml

    output_file_ext: ['svg']


.. _mcomp-file_paths-mgen_script_path_spec:

mgen_script_path
================

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

Path to mgen_script.

Example:-

.. code-block:: pyml

    mgen_script_path: auto


.. _mcomp-file_paths-mgen_output_folder_spec:

mgen_output_folder
==================

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

mgen_script output folder.

Example:-

.. code-block:: pyml

    mgen_output_folder: auto


.. _mcomp-file_paths-mfit_script_path_spec:

mfit_script_path
================

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

Path to mfit_script.

Example:-

.. code-block:: pyml

    mfit_script_path: auto


.. _mcomp-file_paths-mfit_output_folder_spec:

mfit_output_folder
==================

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

mfit_script output folder.

Example:-

.. code-block:: pyml

    mfit_output_folder: auto


.. _mcomp-mcomp_options_spec:

MCOMP_OPTIONS
*************

Type: :term:`dict_record <dict_record>`

Options for mcomp script

Example:-

.. code-block:: pyml

    MCOMP_OPTIONS:
        dot_size: 12


.. _mcomp-mcomp_options-dot_size_spec:

dot_size
========

Type: :term:`int <int>`

Size of dots appearing in scatter plots

Example:-

.. code-block:: pyml

    dot_size: 12



