Documentation

src/tetrax/helpers/math.py

 """
-This submodule contains a number of mathematical functions.
+This submodule contains a number of mathematical functions. The import convention
+
+    >>> import numpy as np
+
+is used.
 """
 import numpy as np
 from scipy.sparse import dia_matrix, bmat
@@ -29,7 +33,7 @@ def flattened_mesh_vec_abs(vec):
 
     Returns
     -------
-    numpy.array
+    np.array
         Flattened mesh scalar of shape `(N,)`.
     """
     nx = vec.shape[0] // 3
@@ -193,16 +197,16 @@ def spherical_angles_to_mesh_vector(theta, phi, as_flattened=False):
 
     Parameters
     ----------
-    theta : numpy.array
+    theta : np.array
         Polar angle at each node point.
-    phi : numpy.array
+    phi : np.array
         Azimuthal angle at each node point.
     as_flattened : bool, optional
         Return resulting unit vector as flattened mesh vector (default is `False`).
 
     Returns
     -------
-    numpy.array
+    np.array
        Unit mesh vector of shape `(N, 3)` if `as_flattened=False` or as flattened mesh vector of shape `(3*N,)` if `as_flattened=True`.
     """