:orphan:

.. The content of this file was generated
.. automatically by the popy.conf.fio.rstdoc_writer module
.. at 19 Mar 2026, 01:37:10


.. _val_spec:



.. _val-x-method-options-x-spec:

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

Type: :term:`dict_record <dict_record>`

method options for val_script

Example:-

.. code-block:: pyml

    METHOD_OPTIONS:
        py_module: val
        rand_seed: 12345
        float_format: default
        script_log_level: error
        comp_first_rows_only: False


.. _val-x-method-options-x-py-module-x-spec:

py_module
=========

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

Python module required to process this script file

Example:-

.. code-block:: pyml

    py_module: val


.. _val-x-method-options-x-rand-seed-x-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


.. _val-x-method-options-x-float-format-x-spec:

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

Type: :term:`str <str>`

Format string for numerical output

Example:-

.. code-block:: pyml

    float_format: default


.. _val-x-method-options-x-script-log-level-x-spec:

script_log_level
================

Type: :term:`one_of(debug,info,warning,error,critical,notset) <one_of>`

Log level for individual scripts run scripts.

Example:-

.. code-block:: pyml

    script_log_level: error


.. _val-x-method-options-x-comp-first-rows-only-x-spec:

comp_first_rows_only
====================

Type: :term:`bool <bool>`

Compare only first rows of data files. (This is a debugging option.)

Example:-

.. code-block:: pyml

    comp_first_rows_only: False


.. _val-x-file-paths-x-spec:

FILE_PATHS
**********

Type: :term:`dict_record <dict_record>`

file paths for val_script

Example:-

.. code-block:: pyml

    FILE_PATHS:
        output_folder: auto
        input_folder: .


.. _val-x-file-paths-x-output-folder-x-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


.. _val-x-file-paths-x-input-folder-x-spec:

input_folder
============

Type: :term:`input_folder <input_folder>`

Root folder for validation examples

Example:-

.. code-block:: pyml

    input_folder: .


.. _val-x-tests-x-spec:

TESTS
*****

Type: :term:`repeat_dict_record <repeat_dict_record>`

Dictionary of test parameters.

Example:-

.. code-block:: pyml

    TESTS: {}


.. _val-x-tests-x-script-path-x-spec:

script_path
===========

Type: :term:`str <str>`

Input PoPy fit pyml script.

Example:-

.. code-block:: pyml

    script_path:


.. _val-x-tests-x-rtol-x-spec:

rtol
====

Type: :term:`float <float>`

Relative tolerance for comparisons with prev PoPy res.

Example:-

.. code-block:: pyml

    rtol: 0.01


.. _val-x-tests-x-atol-x-spec:

atol
====

Type: :term:`float <float>`

Absolute tolerance for comparisons iwth prev PoPy res.

Example:-

.. code-block:: pyml

    atol: 0.01



