Skip to content

Commit

Permalink
Update config_generated.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
eivindjahren authored Dec 10, 2024
1 parent ffe1438 commit ee39389
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions docs/everest/config_generated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Type: *Optional[ModelConfig]*
Configuration of the Everest model

**realizations (optional)**
Type: *List[NonNegativeInt]*
Type: *list[NonNegativeInt]*

List of realizations to use in optimization ensemble.

Expand All @@ -22,7 +22,7 @@ Configuration of the Everest model


**realizations_weights (optional)**
Type: *Optional[List[float]]*
Type: *Optional[list[float]]*

List of weights, one per realization.

Expand All @@ -32,7 +32,7 @@ Configuration of the Everest model

controls (required)
-------------------
Type: *List[ControlConfig]*
Type: *list[ControlConfig]*

Defines a list of controls.
Controls should have unique names each control defines
Expand All @@ -57,7 +57,7 @@ a group of control variables


**variables (required)**
Type: *Union[List[ControlVariableConfig], List[ControlVariableGuessListConfig]]*
Type: *Union[list[ControlVariableConfig], list[ControlVariableGuessListConfig]]*

List of control variables

Expand Down Expand Up @@ -92,7 +92,7 @@ a group of control variables


**scaled_range (optional)**
Type: *Optional[Tuple[float, float]]*
Type: *Optional[tuple[float, float]]*


Can be used to set the range of the variable values
Expand Down Expand Up @@ -148,7 +148,7 @@ a group of control variables


**options (optional)**
Type: *Optional[Mapping[str, Any]]*
Type: *Optional[dict[str, Any]]*


Specifies a dict of optional parameters for the sampler backend.
Expand All @@ -171,7 +171,7 @@ a group of control variables


**initial_guess (optional)**
Type: *List[float]*
Type: *list[float]*

List of Starting values for the control variable

Expand Down Expand Up @@ -271,7 +271,7 @@ a group of control variables


**scaled_range (optional)**
Type: *Optional[Tuple[float, float]]*
Type: *Optional[tuple[float, float]]*


Can be used to set the range of the control values
Expand Down Expand Up @@ -312,7 +312,7 @@ a group of control variables


**options (optional)**
Type: *Optional[Mapping[str, Any]]*
Type: *Optional[dict[str, Any]]*


Specifies a dict of optional parameters for the sampler backend.
Expand Down Expand Up @@ -381,7 +381,7 @@ Optimizer options


**backend_options (optional)**
Type: *Optional[Mapping[str, Any]]*
Type: *Optional[dict[str, Any]]*

Dict of optional parameters for the optimizer backend.
This dict of values is passed unchanged to the selected algorithm in the backend.
Expand Down Expand Up @@ -521,7 +521,7 @@ Optimizer options


**options (optional)**
Type: *Optional[List[str]]*
Type: *Optional[list[str]]*

specifies non-validated, optional
passthrough parameters for the optimizer
Expand Down Expand Up @@ -574,7 +574,7 @@ Optimizer options

objective_functions (required)
------------------------------
Type: *List[ObjectiveFunctionConfig]*
Type: *list[ObjectiveFunctionConfig]*

List of objective function specifications

Expand Down Expand Up @@ -697,7 +697,7 @@ The environment of Everest, specifies which folders are used for simulation and

wells (optional)
----------------
Type: *List[WellConfig]*
Type: *list[WellConfig]*

A list of well configurations, all with unique names.

Expand Down Expand Up @@ -726,12 +726,12 @@ A list of well configurations, all with unique names.

input_constraints (optional)
----------------------------
Type: *Optional[List[InputConstraintConfig]]*
Type: *Optional[list[InputConstraintConfig]]*

List of input constraints

**weights (required)**
Type: *Mapping[str, float]*
Type: *dict[str, float]*

**Example**
If we are trying to constrain only one control (i.e the z control) value:
Expand Down Expand Up @@ -795,7 +795,7 @@ List of input constraints

output_constraints (optional)
-----------------------------
Type: *Optional[List[OutputConstraintConfig]]*
Type: *Optional[list[OutputConstraintConfig]]*

A list of output constraints with unique names.

Expand Down Expand Up @@ -1100,7 +1100,7 @@ Simulation settings

install_jobs (optional)
-----------------------
Type: *Optional[List[InstallJobConfig]]*
Type: *Optional[list[InstallJobConfig]]*

A list of jobs to install

Expand All @@ -1119,7 +1119,7 @@ A list of jobs to install

install_workflow_jobs (optional)
--------------------------------
Type: *Optional[List[InstallJobConfig]]*
Type: *Optional[list[InstallJobConfig]]*

A list of workflow jobs to install

Expand All @@ -1138,7 +1138,7 @@ A list of workflow jobs to install

install_data (optional)
-----------------------
Type: *Optional[List[InstallDataConfig]]*
Type: *Optional[list[InstallDataConfig]]*

A list of install data elements from the install_data config
section. Each item marks what folders or paths need to be copied or linked
Expand Down Expand Up @@ -1173,7 +1173,7 @@ in order for the evaluation jobs to run.

install_templates (optional)
----------------------------
Type: *Optional[List[InstallTemplateConfig]]*
Type: *Optional[list[InstallTemplateConfig]]*

Allow the user to define the workflow establishing the model
chain for the purpose of sensitivity analysis, enabling the relationship
Expand Down Expand Up @@ -1201,7 +1201,7 @@ evaluated.

forward_model (optional)
------------------------
Type: *Optional[List[str]]*
Type: *Optional[list[str]]*

List of jobs to run

Expand All @@ -1213,13 +1213,13 @@ Type: *Optional[WorkflowConfig]*
Workflows to run during optimization

**pre_simulation (optional)**
Type: *Optional[List[str]]*
Type: *Optional[list[str]]*

List of workflow jobs triggered pre-simulation


**post_simulation (optional)**
Type: *Optional[List[str]]*
Type: *Optional[list[str]]*

List of workflow jobs triggered post-simulation

Expand Down Expand Up @@ -1314,13 +1314,13 @@ Settings to control the exports of a optimization run by everest.


**keywords (optional)**
Type: *Optional[List[str]]*
Type: *Optional[list[str]]*

List of eclipse keywords to be exported into csv.


**batches (optional)**
Type: *Optional[List[int]]*
Type: *Optional[list[int]]*

list of batches to be exported, default is all batches.

Expand Down

0 comments on commit ee39389

Please sign in to comment.