Replace generate_splines by a more flexible class

Also allow to calculate the derivative of the radial integral numerically.
Luthaf · Aug 3, 2023 · 87ecb0c · 87ecb0c
1 parent 4648a26
commit 87ecb0c
Show file tree

Hide file tree

Showing 10 changed files with 526 additions and 346 deletions.
diff --git a/docs/src/references/api/python/misc.rst b/docs/src/references/api/python/misc.rst
@@ -13,5 +13,3 @@ Miscelaneous
 .. autoclass:: rascaline.Profiler
     :members:
     :undoc-members:
-
-.. autofunction:: rascaline.generate_splines
diff --git a/docs/src/references/api/python/utils/index.rst b/docs/src/references/api/python/utils/index.rst
@@ -8,3 +8,4 @@ Utility functions and classes that extend the core usage of rascaline.
     :maxdepth: 1
 
     power-spectrum
+    splines
diff --git a/docs/src/references/api/python/utils/splines.rst b/docs/src/references/api/python/utils/splines.rst
@@ -0,0 +1 @@
+.. automodule:: rascaline.utils.splines
diff --git a/python/rascaline/examples/splined-radial-integral.py b/python/rascaline/examples/splined-radial-integral.py
@@ -1,4 +1,6 @@
 """
+.. _example-splines:
+
 Splined radial integrals
 ========================
 
@@ -20,7 +22,8 @@
 from scipy.special import jv
 from scipy.special import spherical_jn as j_l
 
-from rascaline import SphericalExpansion, generate_splines
+from rascaline import SphericalExpansion
+from rascaline.utils import SplinerFromFunction
 
 
 # %%
@@ -114,16 +117,16 @@ def laplacian_eigenstate_basis_derivative(n, el, r):
 # %%
 #
 # The radial basis functions and their derivatives can be input into a spline
-# generator. This will output the positions of the spline points, the
+# generator class. This will output the positions of the spline points, the
 # values of the basis functions evaluated at the spline points, and the
 # corresponding derivatives.
-spline_points = generate_splines(
-    laplacian_eigenstate_basis,
-    laplacian_eigenstate_basis_derivative,
-    max_radial,
-    max_angular,
-    cutoff,
-    requested_accuracy=1e-5,
+spliner = SplinerFromFunction(
+    radial_integral=laplacian_eigenstate_basis,
+    cutoff=cutoff,
+    max_radial=max_radial,
+    max_angular=max_angular,
+    radial_integral_derivative=laplacian_eigenstate_basis_derivative,
+    accuracy=1e-5,
 )
 
 # %%
@@ -136,11 +139,7 @@ def laplacian_eigenstate_basis_derivative(n, el, r):
     "max_radial": max_radial,
     "max_angular": max_angular,
     "center_atom_weight": 0.0,
-    "radial_basis": {
-        "TabulatedRadialIntegral": {
-            "points": spline_points,
-        }
-    },
+    "radial_basis": spliner.compute(),
     "atomic_gaussian_width": 1.0,  # ignored
     "cutoff_function": {"Step": {}},
 }

diff --git a/python/rascaline/rascaline/__init__.py b/python/rascaline/rascaline/__init__.py
@@ -1,19 +1,30 @@
 from . import utils  # noqa
+from .calculators import (
+    AtomicComposition,
+    CalculatorBase,
+    LodeSphericalExpansion,
+    NeighborList,
+    SoapPowerSpectrum,
+    SoapRadialSpectrum,
+    SortedDistances,
+    SphericalExpansion,
+    SphericalExpansionByPair,
+)
 from .log import set_logging_callback  # noqa
 from .profiling import Profiler  # noqa
 from .status import RascalError  # noqa
 from .systems import IntoSystem, SystemBase  # noqa
 from .version import __version__  # noqa
 
 
-from .calculators import CalculatorBase  # noqa  isort: skip
-from .calculators import AtomicComposition  # noqa  isort: skip
-from .calculators import SortedDistances  # noqa  isort: skip
-from .calculators import NeighborList  # noqa  isort: skip
-from .calculators import LodeSphericalExpansion  # noqa isort: skip
-from .calculators import SphericalExpansion  # noqa  isort: skip
-from .calculators import SphericalExpansionByPair  # noqa  isort: skip
-from .calculators import SoapRadialSpectrum  # noqa  isort: skip
-from .calculators import SoapPowerSpectrum  # noqa  isort: skip
-
-from .splines import generate_splines  # noqa  isort: skip
+__all__ = [
+    "AtomicComposition",
+    "CalculatorBase",
+    "LodeSphericalExpansion",
+    "NeighborList",
+    "SoapPowerSpectrum",
+    "SoapRadialSpectrum",
+    "SortedDistances",
+    "SphericalExpansion",
+    "SphericalExpansionByPair",
+]
diff --git a/python/rascaline/rascaline/splines.py b/python/rascaline/rascaline/splines.py
diff --git a/python/rascaline/rascaline/utils/__init__.py b/python/rascaline/rascaline/utils/__init__.py
@@ -3,9 +3,10 @@
 import equistore.core
 
 from .power_spectrum import PowerSpectrum
+from .splines import SplinerBase, SplinerFromFunction
 
 
-__all__ = ["PowerSpectrum"]
+__all__ = ["PowerSpectrum", "SplinerBase", "SplinerFromFunction"]
 
 
 # path that can be used with cmake to access the rascaline library and headers