DORiE Configuration File Guide
******************************

.. contents::
	:depth: 2

.. _inifile-syntax:

File Syntax
===========

The Parameter File follows a simple syntax derived from the DUNE ParameterTree Parser:

.. productionlist:: ini
	heading: '[', key, { '.', key }, ']'
	line: key, { '.', key }, '=', { value }
	key: `string` | `int`
	value: `string` | { `double` } | { `int` }

A set of rules defines this syntax:

* Every key (or every set of keys, respectively) must be unique
* Empty lines and (remnants of) lines following a hash (``#``) are ignored
* Keys must not contain spaces
* For vector values, the vector entries are separated by spaces.
* String valued entries may not contain spaces *or* have to be contained by quotes (``"``). However, doing the latter is not recommended.
* Keys can be nested and are separated by dots (``.``)
* Headings can be nested within their heading declaration and last until the next heading declaration.
* When parsed, headings are placed in front of the actual keys, i.e.

   .. code-block:: none

		[heading1.heading2]
		key1.key2 = value
		key1.key3 = value

   is equivalent with

   .. code-block:: none
	
		heading1.heading2.key1.key2 = value
		heading1.heading2.key1.key3 = value


.. _inifile-cheatsheet:

Cheat Sheets
============

These cheat sheets are automatically generated by
:doc:`the Parameter Scraper <python-dorie-parscraper>`.
The configuration files are used for the Parameter Field Generator module and
the main simulation routine. They are executed by `dorie pfg <config>` and
`dorie run <config>`, respectively, see the
:doc:`CLI documentation <python-dorie-wrapper>`.

Parameter Field Generator
-------------------------

.. include:: default_files/field-parameters.rst


Main Routine
------------

.. include:: default_files/parameters.rst