Affine-parametric Operators, Parametric ROMs

.gitignore

@@ -11,6 +11,7 @@ docs/source/opinf/literature.md
 __pycache__/
 .ipynb_checkpoints/
 .pytest_cache/
+.ruff_cache/
 htmlcov/
 .coverage*
 build/
@@ -52,3 +53,4 @@ html/
 # Other
 *.swp
 .markdownlint.json
+Notes/

docs/_config.yml

@@ -68,6 +68,9 @@ sphinx:
       sklearn:
         - "https://scikit-learn.org/stable/"
         - null
+      pandas:
+        - "https://pandas.pydata.org/docs/"
+        - null
     mathjax3_config:
       tex:
         macros:

docs/_toc.yml

@@ -21,7 +21,10 @@ parts:
     # numbered: 1
     chapters:
     - file: source/tutorials/basics.ipynb
-    - file: source/tutorials/heat_equation.ipynb
+    - file: source/tutorials/inputs.ipynb
+    # - file: source/tutorials/lifting.ipynb
+    # - file: source/tutorials/regularization.ipynb
+    - file: source/tutorials/parametric.ipynb
 
   # API reference via sphinx-autodoc + limited handwritten documentation.
   - caption: API Reference

docs/source/api/ddt.ipynb

@@ -25,7 +25,7 @@
     "   DerivativeEstimatorTemplate\n",
     "   UniformFiniteDifferencer\n",
     "   NonuniformFiniteDifferencer\n",
-    "   InterpolationDerivativeEstimator\n",
+    "   InterpDerivativeEstimator\n",
     "\n",
     "**Finite Difference Schemes for Uniformly Spaced Data**\n",
     "\n",
@@ -352,7 +352,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The {class}`InterpolationDerivativeEstimator` interpolates the state data using classes from {mod}`scipy.interpolate` and evaluates the derivative of the interpolant."
+    "The {class}`InterpDerivativeEstimator` interpolates the state data using classes from {mod}`scipy.interpolate` and evaluates the derivative of the interpolant."
    ]
   },
   {
@@ -361,7 +361,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "estimator = opinf.ddt.InterpolationDerivativeEstimator(t, \"cubic\")\n",
+    "estimator = opinf.ddt.InterpDerivativeEstimator(t, \"pchip\")\n",
     "print(estimator)"
    ]
   },

docs/source/api/missing.rst

@@ -64,7 +64,7 @@ ddt.ipynb
    DerivativeEstimatorTemplate
    UniformFiniteDifferencer
    NonuniformFiniteDifferencer
-   InterpolationDerivativeEstimator
+   InterpDerivativeEstimator
    fwd1
    fwd2
    fwd3
@@ -107,16 +107,18 @@ operators.ipynb
    StateInputOperator
    ParametricOperatorTemplate
    ParametricOpInfOperator
-   InterpolatedConstantOperator
-   InterpolatedLinearOperator
-   InterpolatedQuadraticOperator
-   InterpolatedCubicOperator
-   InterpolatedInputOperator
-   InterpolatedStateInputOperator
-   has_inputs
-   is_nonparametric
-   is_parametric
-   is_uncalibrated
+   AffineConstantOperator
+   AffineLinearOperator
+   AffineQuadraticOperator
+   AffineCubicOperator
+   AffineInputOperator
+   AffineStateInputOperator
+   InterpConstantOperator
+   InterpLinearOperator
+   InterpQuadraticOperator
+   InterpCubicOperator
+   InterpInputOperator
+   InterpStateInputOperator
 
 lstsq.ipynb
 -----------

docs/source/api/models.md

@@ -2,6 +2,28 @@
 
 ```{eval-rst}
 .. automodule:: opinf.models
+
+.. currentmodule:: opinf.models
+
+**Nonparametric Models**
+
+.. autosummary::
+    :toctree: _autosummaries
+    :nosignatures:
+
+    ContinuousModel
+    DiscreteModel
+
+**Parametric Models**
+
+.. autosummary::
+    :toctree: _autosummaries
+    :nosignatures:
+
+    ParametricContinuousModel
+    ParametricDiscreteModel
+    InterpContinuousModel
+    InterpDiscreteModel
 ```
 
 :::{admonition} Overview
@@ -55,7 +77,6 @@ A _nonparametric_ model is comprised exclusively of [nonparametric operators](se
 .. currentmodule:: opinf.models
 
 .. autosummary::
-    :toctree: _autosummaries
     :nosignatures:
 
     ContinuousModel
@@ -123,46 +144,55 @@ A _parametric model_ is a model with at least one [parametric operator](sec-oper
 Parametric models are similar to nonparametric models: they are initialized with a list of operators, use `fit()` to calibrate operator entries, and `predict()` to solve the model.
 In addition, parametric models have an `evaluate()` method that returns a nonparametric model at a fixed parameter value.
 
-### Interpolated Models
+```{eval-rst}
+.. currentmodule:: opinf.models
+
+.. autosummary::
+   :nosignatures:
+
+   ParametricContinuousModel
+   ParametricDiscreteModel
+```
+
+### Interpolatory Models
 
-Interpolated models consist exclusively of [interpolated operators](sec-operators-interpolated).
+Interpolatory models consist exclusively of [interpolatory operators](sec-operators-interpolated).
 
 ```{eval-rst}
 .. currentmodule:: opinf.models
 
 .. autosummary::
-    :toctree: _autosummaries
     :nosignatures:
 
-    InterpolatedContinuousModel
-    InterpolatedDiscreteModel
+    InterpContinuousModel
+    InterpDiscreteModel
 ```
 
 :::{tip}
 The `operators` constructor argument for these classes can also be a string that indicates which type of operator to use.
 
 | Character | {mod}`opinf.operators` class |
 | :-------- | :------------------------------- |
-| `'c'` | {class}`opinf.operators.InterpolatedConstantOperator` |
-| `'A'` | {class}`opinf.operators.InterpolatedLinearOperator` |
-| `'H'` | {class}`opinf.operators.InterpolatedQuadraticOperator` |
-| `'G'` | {class}`opinf.operators.InterpolatedCubicOperator` |
-| `'B'` | {class}`opinf.operators.InterpolatedInputOperator` |
-| `'N'` | {class}`opinf.operators.InterpolatedStateInputOperator` |
+| `'c'` | {class}`opinf.operators.InterpConstantOperator` |
+| `'A'` | {class}`opinf.operators.InterpLinearOperator` |
+| `'H'` | {class}`opinf.operators.InterpQuadraticOperator` |
+| `'G'` | {class}`opinf.operators.InterpCubicOperator` |
+| `'B'` | {class}`opinf.operators.InterpInputOperator` |
+| `'N'` | {class}`opinf.operators.InterpStateInputOperator` |
 
 ```python
 import opinf
 
 # Initialize the model with a list of operator objects.
-model = opinf.models.InterpolatedContinuousModel(
+model = opinf.models.InterpContinuousModel(
     operators=[
-        opinf.operators.InterpolatedCubicOperator(),
-        opinf.operators.InterpolatedStateInputOperator(),
+        opinf.operators.InterpCubicOperator(),
+        opinf.operators.InterpStateInputOperator(),
     ]
 )
 
 # Equivalently, initialize the model with a string.
-model = opinf.models.InterpolatedContinuousModel(operators="GN")
+model = opinf.models.InterpContinuousModel(operators="GN")
 ```
 
 :::