Make the wells section optional

- The `wells` section it is made optional. If not present, the well
  names are derived from the well type (`well_control`).
- If no `wells:` section is present, a default `wells.json
  containing just the well names is generated, because the forward
  models in `everest-models` may require it.

Author: verveerpj

src/ert/run_models/everest_run_model.py

@@ -140,13 +140,26 @@ class _EvaluationInfo:
 
 def _get_well_file(ever_config: EverestConfig) -> tuple[Path, str]:
     assert ever_config.output_dir is not None
+
+    def _get_variables(controls: list[ControlConfig]) -> list[dict[str, Any]]:
+        wells = []
+        for control in controls:
+            if control.type != "well_control":
+                continue
+            for variable in control.variables:
+                if variable.name not in wells:
+                    wells.append(variable.name)
+        return [{"name": name} for name in wells]
+
     data_storage = (Path(ever_config.output_dir) / ".internal_data").resolve()
     return (
         data_storage / "wells.json",
         json.dumps(
-            [
+            _get_variables(ever_config.controls)
+            if ever_config.wells is None
+            else [
                 x.model_dump(exclude_none=True, exclude_unset=True)
-                for x in ever_config.wells or []
+                for x in ever_config.wells
             ]
         ),
     )

src/everest/config/everest_config.py

@@ -293,11 +293,20 @@ class EverestConfig(BaseModelWithContextSupport):
             well as the level of detail in the logs""",
         ),
     )
-    wells: list[WellConfig] = Field(
-        default_factory=list,
+    wells: list[WellConfig] | None = Field(
+        default=None,
         description=dedent(
             """
-            A list of well configurations.
+            An optional list of well configurations.
+
+            Each well configuration consists of a `name` field, and an optional
+            `drill_time` field. All variables in control groups with
+            `control.type == "well_control"` must also be listed in this
+            section.
+
+            If not present, a minimal well configuration containing only the
+            names of wells will be derived from controls that have
+            `control.type == "well_control"`.
             """
         ),
     )
@@ -840,7 +849,7 @@ def validate_variable_name_match_well_name(self) -> Self:
         if not well_names:
             return self
         for c in controls:
-            if c.type == "generic_control":
+            if c.type != "well_control":
                 continue
             for v in c.variables:
                 if v.name not in well_names:
@@ -861,7 +870,9 @@ def validate_that_environment_sim_folder_is_writeable(self) -> Self:
     @field_validator("wells")
     @no_type_check
     @classmethod
-    def validate_unique_well_names(cls, wells: list[WellConfig]):
+    def validate_unique_well_names(cls, wells: list[WellConfig] | None):
+        if wells is None:
+            return None
         check_for_duplicate_names([w.name for w in wells], "well", "name")
         return wells
 

src/everest/simulator/everest_to_ert.py

@@ -47,7 +47,16 @@ def extract_summary_keys(ever_config: EverestConfig) -> list[str]:
         [] if ever_config.export is None else ever_config.export.keywords
     )
 
-    wells = [well.name for well in ever_config.wells]
+    wells = (
+        [
+            variable.name
+            for control in ever_config.controls
+            for variable in control.variables
+            if control.type == "well_control"
+        ]
+        if ever_config.wells is None
+        else [w.name for w in ever_config.wells]
+    )
 
     well_keys = [
         f"{sum_key}:{wname}"

test-data/everest/eightcells/everest/model/config.yml

@@ -1,10 +1,6 @@
 definitions:
   eclbase: eclipse/model/EIGHTCELLS
 
-wells:
-  - { name: OP1 }
-  - { name: WI1 }
-
 controls:
   -
     name: well_rate

test-data/everest/math_func/config_advanced.yml

@@ -1,5 +1,3 @@
-wells: []
-
 controls:
   - name: point
     max: 1.0

tests/everest/test_controls.py

@@ -7,7 +7,6 @@
 from everest.config.control_variable_config import (
     ControlVariableConfig,
 )
-from everest.config.well_config import WellConfig
 from everest.optimizer.everest2ropt import everest2ropt
 
 
@@ -169,9 +168,9 @@ def test_that_control_variable_name_with_too_many_dots_is_invalid(min_config):
 
 def test_that_control_variable_without_too_many_dots_does_not_raise(min_config):
     weirdo_name = "something/with-symbols_=/()*&%$#!"
+    min_config["controls"][0]["variables"][0]["name"] = weirdo_name
+    min_config["wells"] = [{"name": weirdo_name}]
     new_config = EverestConfig.model_validate(min_config)
-    new_config.wells.append(WellConfig(name=weirdo_name))
-    new_config.controls[0].variables[0].name = weirdo_name
     EverestConfig.model_validate(new_config.to_dict())
 
 

tests/everest/test_res_initialization.py

@@ -155,15 +155,34 @@ def test_default_installed_jobs(tmp_path, monkeypatch):
 @pytest.mark.filterwarnings(
     "ignore:Config contains a SUMMARY key but no forward model steps"
 )
-def test_combined_wells_everest_to_ert(tmp_path, monkeypatch):
+@pytest.mark.parametrize(
+    "config_yaml",
+    [
+        dedent("""
+    wells: [{ name: fakename}]
+    """),
+        dedent("""
+    controls:
+      - name: default_group
+        type: well_control
+        initial_guess: 0.5
+        perturbation_magnitude: 0.01
+        variables:
+          - name: fakename
+            min: 0
+            max: 1
+    """),
+    ],
+)
+def test_combined_wells_everest_to_ert(tmp_path, monkeypatch, config_yaml):
     monkeypatch.chdir(tmp_path)
     Path("my_file").touch()
     Path("my_executable").touch(mode=stat.S_IEXEC)
     ever_config = EverestConfig.with_defaults(
         **yaml.safe_load(
-            dedent("""
+            config_yaml
+            + dedent("""
     model: {"realizations": [0]}
-    wells: [{ name: fakename}]
     definitions: {eclbase: my_test_case}
     install_jobs:
       - name: nothing
@@ -220,9 +239,22 @@ def test_install_data_no_init(tmp_path, source, target, symlink, cmd, monkeypatc
 
 @pytest.mark.integration_test
 @pytest.mark.skip_mac_ci
-def test_summary_default_no_opm(tmp_path, monkeypatch):
+@pytest.mark.parametrize("wells_config", [None, [{"name": "default_name"}]])
+def test_summary_default_no_opm(tmp_path, monkeypatch, wells_config):
     monkeypatch.chdir(tmp_path)
     everconf = EverestConfig.with_defaults(
+        wells=wells_config,
+        controls=[
+            {
+                "name": "default_group",
+                "type": "well_control",
+                "initial_guess": 0.5,
+                "perturbation_magnitude": 0.01,
+                "variables": [
+                    {"name": "default_name", "min": 0, "max": 1},
+                ],
+            }
+        ],
         forward_model=[
             {
                 "job": "eclipse100 eclipse/model/EgG.DATA --version 2020.2",
@@ -232,10 +264,19 @@ def test_summary_default_no_opm(tmp_path, monkeypatch):
                     "keys": ["*"],
                 },
             }
-        ]
+        ],
     )
     # Read wells from the config instead of using opm
-    wells = [w.name for w in everconf.wells]
+    wells = (
+        [
+            variable.name
+            for control in everconf.controls
+            for variable in control.variables
+            if control.type == "well_control"
+        ]
+        if wells_config is None
+        else [w.name for w in everconf.wells]
+    )
     sum_keys = (
         list(everest.simulator.DEFAULT_DATA_SUMMARY_KEYS)
         + list(everest.simulator.DEFAULT_FIELD_SUMMARY_KEYS)
@@ -714,7 +755,7 @@ def test_that_summary_keys_default_to_expected_keys_according_to_wells(
     min_config["controls"] = [
         {
             "name": "well_rate",
-            "type": "generic_control",
+            "type": "well_control",
             "perturbation_magnitude": 0.01,
             "variables": [
                 {

tests/everest/test_wells.py

@@ -73,7 +73,7 @@ def test_that_well_names_must_be_unique(min_config):
         pytest.param([{"name": "test"}], id="Default value not in result"),
     ],
 )
-def test_well_config_to_file(min_config, monkeypatch, tmp_path, config):
+def test_well_config_to_wells_json(min_config, monkeypatch, tmp_path, config):
     monkeypatch.chdir(tmp_path)
     min_config["wells"] = config
     ever_config = EverestConfig(**min_config)
@@ -84,3 +84,29 @@ def test_well_config_to_file(min_config, monkeypatch, tmp_path, config):
     with open("everest_output/.internal_data/wells.json", encoding="utf-8") as fin:
         wells_json = json.load(fin)
     assert wells_json == config
+
+
+@pytest.mark.parametrize(
+    "variables",
+    [
+        [{"name": "test", "initial_guess": 0.1}],
+        [{"name": "test", "initial_guess": 0.1, "index": 1}],
+        [
+            {"name": "test", "initial_guess": 0.1, "index": 1},
+            {"name": "test", "initial_guess": 0.1, "index": 2},
+        ],
+        [{"name": "test", "initial_guess": [0.1]}],
+        [{"name": "test", "initial_guess": [0.1, 0.1]}],
+    ],
+)
+def test_controls_config_to_wells_json(min_config, monkeypatch, tmp_path, variables):
+    monkeypatch.chdir(tmp_path)
+    min_config["controls"][0]["variables"] = variables
+    ever_config = EverestConfig(**min_config)
+    everest_to_ert_config_dict(ever_config)
+    for datafile, data in _get_internal_files(ever_config).items():
+        datafile.parent.mkdir(exist_ok=True, parents=True)
+        datafile.write_text(data, encoding="utf-8")
+    with open("everest_output/.internal_data/wells.json", encoding="utf-8") as fin:
+        wells_json = json.load(fin)
+    assert wells_json == [{"name": "test"}]