Skip to content

WIP: Migration to design matrix docs #10529

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

WIP: Migration to design matrix docs #10529

Show file tree
Hide file tree
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
23 changes: 23 additions & 0 deletions docs/ert/getting_started/howto/design_matrix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Design matrix
=============

Migration from DESIGN2PARAMS
----------------------------

Migrating from the `DESIGN2PARAMS` forward model involves updating your configuration to use more ert aware `DESIGN_MATRIX` keyword.
The `DESIGN_MATRIX` keyword replaces `DESIGN2PARAMS` by allowing users to define the relationship between design model parameters in a matrix format, offering improved validation and clarity.
To migrate, replace instances of `DESIGN2PARAMS` in your configuration file with `DESIGN_MATRIX`:

For example

::

FORWARD_MODEL DESIGN2PARAMS(<xls_filename>=<CONFIG_PATH>/<DESIGN_MATRIX>, <designsheet>=<DESIGN_SHEET>, <defaultssheet>=DefaultValues)

will be replaced in the following way:

::

DESIGN_MATRIX <CONFIG_PATH>/<DESIGN_MATRIX> DESIGN_SHEET:<DESIGN_SHEET> DEFAULT_SHEET:DefaultValues

Additionally, review the documentation for :ref:`DESIGN_MATRIX <design_matrix>` to understand its syntax and capabilities, as it provides enhanced validation compared to the `DESIGN2PARAMS` model.
1 change: 1 addition & 0 deletions docs/ert/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ To understand the theoretical foundations of ensemble-based methods, head over t
getting_started/howto/adaptive_localization.ipynb
getting_started/updating_parameters/index
getting_started/howto/plugin_system
getting_started/howto/design_matrix
getting_started/webviz-ert/webviz-ert

.. toctree::
Expand Down