more formatting

CROCODILE-CESM · Jan 24, 2025 · 720d5e6 · 720d5e6
1 parent 05ea795
commit 720d5e6
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/regional_mom6/rotation.py b/regional_mom6/rotation.py
@@ -95,7 +95,8 @@ def initialize_grid_rotation_angle(hgrid: xr.Dataset) -> xr.DataArray:
 
 def modulo_around_point(x, xc, Lx):
     """
-    Calculate the modulo around a point. Return the modulo value of x in an interval [xc-(Lx/2), xc+(Lx/2)]. If Lx<=0, then it returns x without applying modulo arithmetic.
+    Calculate the modulo around a point. Return the modulo value of ``x`` in the interval ``[xc-(Lx/2), xc+(Lx/2)]``.
+    If ``Lx ≤ 0``, then it returns ``x`` without applying modulo arithmetic.
 
     Parameters
     ----------
@@ -109,12 +110,12 @@ def modulo_around_point(x, xc, Lx):
     Returns
     -------
     float
-        x shifted by an integer multiple of Lx to be close to xc,
+        x shifted by an integer multiple of Lx to be close to xc
     """
     if Lx <= 0:
         return x
     else:
-        return ((x - (xc - 0.5 * Lx)) % Lx) - Lx / 2 + xc
+        return ((x - (xc - Lx / 2)) % Lx) - Lx / 2 + xc
 
 
 def mom6_angle_calculation_method(

diff --git a/regional_mom6/utils.py b/regional_mom6/utils.py
@@ -322,10 +322,11 @@ def setup_logger(
 def rotate_complex(u, v, radian_angle):
     """
     Rotate velocities to grid orientation using complex number math (Same as rotate)
-    Args:
+
+    Arguments:
         u (xarray.DataArray): The u-component of the velocity.
         v (xarray.DataArray): The v-component of the velocity.
-        radian_angle (xarray.DataArray): The angle of the grid in RADIANS
+        radian_angle (xarray.DataArray): The angle of the grid in radians.
 
     Returns:
         Tuple[xarray.DataArray, xarray.DataArray]: The rotated u and v components of the velocity.
@@ -346,10 +347,11 @@ def rotate_complex(u, v, radian_angle):
 def rotate(u, v, radian_angle):
     """
     Rotate the velocities to the grid orientation.
-    Args:
+
+    Arguments:
         u (xarray.DataArray): The u-component of the velocity.
         v (xarray.DataArray): The v-component of the velocity.
-        radian_angle (xarray.DataArray): The angle of the grid in RADIANS
+        radian_angle (xarray.DataArray): The angle of the grid in radians.
 
     Returns:
         Tuple[xarray.DataArray, xarray.DataArray]: The rotated u and v components of the velocity.