Instruct how to activate adloc via config

equinor · Dec 29, 2023 · 0962817 · 0962817
1 parent 5e2df1f
commit 0962817
Showing 1 changed file with 27 additions and 10 deletions.
diff --git a/docs/getting_started/howto/adaptive_localization.ipynb b/docs/getting_started/howto/adaptive_localization.ipynb
@@ -168,22 +168,39 @@
    "source": [
     "## Adaptive-Localization - Pearson Correlation as measure of closeness\n",
     "\n",
-    "As mentioned, the difference between distance-based localization and adaptive-localization is the measure of closeness.\n",
-    "Otherwise, the approaches are similar.\n",
+    "As mentioned, the key difference between distance-based localization and adaptive-localization is the measure of closeness.\n",
     "\n",
     "- **Adaptive Localization step-by-step:**\n",
-    "    - Pick a subset of adjacent parameters\n",
-    "    - Pick responses that are significantly correlated to the parameters\n",
-    "    - Do the update using only observations that correspond to these responses\n",
+    "    - Select a subset of adjacent parameters\n",
+    "    - Choose responses that are significantly correlated to these parameters\n",
+    "    - Update using only observations that correspond to these responses\n",
     "\n",
-    "The primary advantage of adaptive localization is its user-friendliness as users only need to (optionally) specify the `correlation threshold`.\n",
+    "Adaptive localization's main benefit is its user-friendliness, as it primarily requires users to set the `correlation threshold`, which is optional.\n",
     "\n",
-    "To activate adaptive localization in `ERT`, simply check the `Adaptive localization correlation threshold` checkbox.\n",
-    "This activates adaptive localization for the entire experiment, meaning it will run for every iteration of, say, `ES-MDA`.\n",
+    "## Enabling via the GUI\n",
+    "\n",
+    "In `ERT`, activate adaptive localization by ticking the `Adaptive localization correlation threshold` checkbox.\n",
+    "This enables it for the entire experiment, meaning it will run for every iteration of, say, `ES-MDA`.\n",
     "While the correlation threshold can be manually set, `ERT` determines a sensible default based on the size of the ensemble.\n",
-    "At a correlation threshold of 0.0 the update will be identical to no localization, while at a correlation threshold of 1.0 the posterior will be identical to the prior, and there will be no update.\n",
+    "At a threshold of 0.0, the update will be identical to no localization, while at 1.0, it results in the posterior being identical to the prior, hence no update.\n",
+    "\n",
+    "![](ert_screenshot_adaptive_loc.png)\n",
+    "\n",
+    "## Enabling via Configuration File (Applicable to both CLI and GUI)\n",
+    "\n",
+    "To enable adaptive localization using the config file, insert:\n",
+    "\n",
+    "```\n",
+    "ANALYSIS_SET_VAR STD_ENKF LOCALIZATION True\n",
+    "```\n",
+    "\n",
+    "This setting activates adaptive localization for both CLI and GUI executions.\n",
+    "\n",
+    "To manually set the localization threshold via the config-file, include:\n",
     "\n",
-    "![](ert_screenshot_adaptive_loc.png)"
+    "```\n",
+    "ANALYSIS_SET_VAR STD_ENKF LOCALIZATION_CORRELATION_THRESHOLD 1.0\n",
+    "```"
    ]
   },
   {