From c85fc00967cf057fb9ef7b576fb4e9e228607874 Mon Sep 17 00:00:00 2001 From: Andrew Date: Wed, 18 May 2022 15:17:13 -0600 Subject: [PATCH] add warning that job expansion does not work with low-level api. --- docs/source/guides/advanced_configuration_guide.inc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/source/guides/advanced_configuration_guide.inc b/docs/source/guides/advanced_configuration_guide.inc index b0e426c2..34ba81f5 100644 --- a/docs/source/guides/advanced_configuration_guide.inc +++ b/docs/source/guides/advanced_configuration_guide.inc @@ -7,7 +7,12 @@ Advanced model configurations Configuring multiple model runs from a single YAML file ============================================================== -Multiple model runs (referred to as "jobs") can be configured by a single `.yml` configuration file, by using the `matrix` and `ensemble` configuration keys. +Multiple model runs (referred to as "jobs") can be configured by a single `.yml` configuration file and passing the file to the high-level API. +Multiple runs can be configured by using the `matrix`, `ensemble`, and `set` configuration keys in the `.yml` file. + +.. important:: + + You cannot use any of `matrix` `ensemble` or `set` with the low-level API. If you need, you could use the high-level API to generate the scripts for each job (e.g., `timesteps: 0`) and then manually generate `DeltaModel` instances from each `.yml` file to then use with the low-level API. .. _matrix_expansion_tag: