Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add warning that job expansion does not work with low-level api. #249

Merged
merged 1 commit into from
May 18, 2022
Merged

add warning that job expansion does not work with low-level api. #249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/source/guides/advanced_configuration_guide.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down