Rename constructors to recipes (#64)

Rename the `create_inversion` function to `create_l2_inversion`. Update
notebooks.

Author: santisoler

notebooks/09_inversion-with-constructor.ipynb

@@ -244,7 +244,7 @@
     "chi_target = 1.0\n",
     "initial_model = np.zeros(n_params)\n",
     "\n",
-    "inversion = ii.create_inversion(\n",
+    "inversion = ii.create_l2_inversion(\n",
     "    data_misfit,\n",
     "    smallness,\n",
     "    starting_beta=starting_beta,\n",

notebooks/12_gravity-inversion-with-constructor.ipynb

@@ -464,7 +464,7 @@
    "source": [
     "initial_model = np.zeros(simulation.n_params)\n",
     "\n",
-    "inversion = ii.create_inversion(\n",
+    "inversion = ii.create_l2_inversion(\n",
     "    data_misfit,\n",
     "    smallness,\n",
     "    starting_beta=1e6,\n",

src/inversion_ideas/__init__.py

@@ -5,7 +5,6 @@
 from . import base, typing, utils
 from ._version import __version__
 from .conditions import ChiTarget, CustomCondition, ModelChanged, ObjectiveChanged
-from .constructors import create_inversion, create_sparse_inversion
 from .data_misfit import DataMisfit
 from .directives import (
     Irls,
@@ -17,6 +16,7 @@
 from .inversion_log import InversionLog, InversionLogRich
 from .minimize import GaussNewtonConjugateGradient, conjugate_gradient
 from .preconditioners import JacobiPreconditioner, get_jacobi_preconditioner
+from .recipes import create_l2_inversion, create_sparse_inversion
 from .regularization import Flatness, Smallness, SparseSmallness, TikhonovZero
 from .simulations import wrap_simulation
 
@@ -42,7 +42,7 @@
     "__version__",
     "base",
     "conjugate_gradient",
-    "create_inversion",
+    "create_l2_inversion",
     "create_sparse_inversion",
     "get_jacobi_preconditioner",
     "typing",

src/inversion_ideas/constructors.py renamed to src/inversion_ideas/recipes.py

@@ -1,5 +1,5 @@
 """
-Functions to easily build commonly used objects in inversions.
+Recipe functions to easily build commonly used inversions.
 """
 
 from collections.abc import Callable
@@ -14,7 +14,7 @@
 from .typing import Model, Preconditioner
 
 
-def create_inversion(
+def create_l2_inversion(
     data_misfit: Objective,
     model_norm: Objective,
     *,