Document Adaptive Localization

[dafeda]

Issue
Resolves #6232

Pre review checklist

• Read through the code changes carefully after finishing work
• Make sure tests pass locally (after every commit!)
• Prepare changes in small commits for more convenient review (optional)
• PR title captures the intent of the changes, and is fitting for release notes.
• Updated documentation
• Ensured that unit tests are added for all new behavior (See
  Ground Rules),
  and changes to existing code have good test coverage.

Pre merge checklist

• Added appropriate release note label
• Commit history is consistent and clean, in line with the contribution guidelines.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (050d02a) 83.78% compared to head (3eb84aa) 83.78%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6682   +/-   ##
=======================================
  Coverage   83.78%   83.78%           
=======================================
  Files         365      365           
  Lines       21293    21293           
  Branches      948      948           
=======================================
  Hits        17841    17841           
  Misses       3158     3158           
  Partials      294      294           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tommyod]

Comment on notebooks.

In iterative_ensemble_smoother we use myst_nb for notebook support. We store py and convert to .ipynb in conf.py.

In a hobby project of mine (generalized-additive-models) I had success using bsphinx and config for jupytext these lines. The end result is pretty much the same, I think: storing py files.

[kvashchuka]

I do not see section numbering, can we use a link instead?

[dafeda]

I've not been able to make links work when using nbsphinx.
I've pushed a fix that just asks the user to see section below... Not great but will have to do for now I think.

[dafeda]

I've added a section on computational considerations.
I think this is good to go.

[oyvindeide]

Good job!