Skip to content

Commit a04d7f4

Browse files
committed
Document disallowed words in design matrix
The rejected values were undocumented. A cell holding a word such as NONE is visibly non-empty, so an error calling it empty or invalid is hard to act on without a list of what is accepted.
1 parent 1ebe620 commit a04d7f4

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

docs/ert/getting_started/howto/design_matrix.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ NOTE: The DESIGN_MATRIX validation is more strict than that of DESIGN2PARAMS.
3939
Some problems that were previously hidden or resulting in failures during runtime, will now result
4040
in errors during validation of the configuration:
4141

42-
- Missing values (empty cells) in the design matrix
42+
- Missing or invalid values in the design matrix
43+
(see :ref:`accepted cell values <design_matrix_cell_values>`)
4344
- Duplicate parameter names in the design matrix
4445
- Design sheet is empty
4546
- REAL column must only contain unique, positive integers

docs/ert/reference/configuration/keywords.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -360,6 +360,13 @@ the final set of parameters (for example in parameters.txt in real==0) would be:
360360
as inactive in the ensemble and not run. For example, if the DESIGN_MATRIX only contains realization
361361
id 3, then the ensemble_size will be four. Here the realizations 0, 1, and 2 will be marked as inactive and not run.
362362

363+
.. _design_matrix_cell_values:
364+
.. note::
365+
Every cell in a used row or column of the design sheet and the default
366+
sheet must hold a value. A cell is invalid if it is empty, contains only
367+
whitespace, holds a numeric ``NaN``, or holds the text ``NONE``, ``NULL``
368+
or ``NAN`` in any casing. Surrounding whitespaces are ignored.
369+
363370
.. _eclbase:
364371

365372
ECLBASE

0 commit comments

Comments
 (0)