Debian Codegraph @

doc/files.rst

raw
1 Configuration files
2 ===================
3
4 The RC file
5 -----------
6
7 Some of the command line options can be specified in an rc file. By default,
8 flent looks for this in :file:`~/.flentrc`, but an alternative location can be
9 specified with the :option:`--rcfile` command line option.
10
11 The rc file allows options to be specified globally, an optionally overridden
12 for specific tests. For an explanation of the options, refer to the annotated
13 example rc file, by default installed to
14 :file:`/usr/share/doc/flent/flentrc.example`.
15
16 Batch Files
17 -----------
18
19 Flent supports reading batch files to automate running several tests and
20 do setup/teardown of test environment etc. This greatly aids
21 reproducibility of tests.
22
23 The batch file is parsed as an ini file, and can have three types of sections:
24 batches, commands and args. Each section also has a name; type and name are
25 separated with two colons. 'Batches' are named tests that can be selected from
26 the command line, 'commands' are system commands to be run before or after each
27 test run, and 'args' are used in the looping mechanism (which allows repeating
28 tests multiple times with different parameters).
29
30 Variables in sections control the operation of Flent and can be modified in
31 several ways: Sections of the same type can inherit from each other and the
32 variables in an 'arg' section will be interpolated into the batch definition on
33 each iteration of a loop. In addition, variable contents can be substituted into
34 other variables by using the ${varname} syntax. These three operations are
35 resolved in this order (inheritance, arg interpolation and variable
36 substitution).
37
38 An annotated example batchfile is distributed with the source code, and is by
39 default installed to :file:`/usr/share/doc/flent/batchfile.example`.