Data class docstring fixes

Author: kysolvik

dabench/data/_barotropic.py

@@ -36,6 +36,7 @@ class Barotropic(_data.Data):
     See https://pyqg.readthedocs.io
 
     Notes:
+        DEPRECATED
         Uses default attribute values from pyqg.BTModel:
         https://pyqg.readthedocs.io/en/latest/api.html#pyqg.BTModel
         Those values originally come from Mcwilliams 1984:
@@ -207,8 +208,8 @@ def __advance__(self,):
         """Advances the QG model according to set attributes
 
         Returns:
-            qs (array_like): absolute potential vorticity (relative potential
-                vorticity + background vorticity).
+            Array of absolute potential vorticity (relative potential
+            vorticity + background vorticity).
         """
         qs = []
         for _ in self.m.run_with_snapshots(tsnapstart=0, tsnapint=self.m.dt):

dabench/data/_data.py

@@ -114,8 +114,8 @@ def generate(self,
                 convergence tolerance, etc.).
 
         Returns:
-            Xarray Dataset of output vector and (if return_tlm=True)
-                Xarray DataArray of TLMs corresponding to the system trajectory.
+            Xarray Dataset of output vector, and if return_tlm=True
+            Xarray DataArray of TLMs corresponding to the system trajectory.
         """
 
         # Check that n_steps or t_final is supplied
@@ -279,7 +279,7 @@ def calc_lyapunov_exponents_series(
 
         Returns:
             Lyapunov exponents for all timesteps, array of size
-                (total_time/rescale_time - 1, system_dim)
+            (total_time/rescale_time - 1, system_dim)
         """
 
         # Set total_time

dabench/data/_pyqg.py

@@ -31,6 +31,7 @@ class PyQG(_data.Data):
     See https://pyqg.readthedocs.io
 
     Notes:
+        DEPRECATED
         Uses default attribute values from pyqg.QGModel:
         https://pyqg.readthedocs.io/en/latest/api.html#pyqg.QGModel
 
@@ -191,8 +192,8 @@ def __advance__(self,):
         """Advances the QG model according to set attributes
 
         Returns:
-            qs (array_like): absolute potential vorticity (relative potential
-                vorticity + background vorticity).
+            Array of absolute potential vorticity (relative potential
+            vorticity + background vorticity).
         """
         qs = []
         for _ in self.m.run_with_snapshots(tsnapstart=0, tsnapint=self.m.dt):

dabench/data/_qgs.py

@@ -124,12 +124,11 @@ def rhs(self,
         """Vector field (tendencies) of qgs system
 
         Args:
-            x: State vector, shape: (system_dim)
+            x: State vector of size (system_dim)
             t: times vector. Required as argument slot for some numerical
                 integrators but unused.
         Returns:
             Vector field of qgs
-
         """
 
         dx = self.f(t, x)
@@ -143,13 +142,12 @@ def Jacobian(self,
         """Jacobian of the qgs system
 
         Args:
-            x: State vector, shape: (system_dim)
+            x: State vector of size (system_dim)
             t: times vector. Required as argument slot for some numerical
                 integrators but unused.
 
         Returns:
-            J: Jacobian matrix, shape: (system_dim, system_dim)
-
+            Jacobian matrix of size (system_dim, system_dim)
         """
 
         J = self.Df(t, x)
@@ -187,8 +185,8 @@ def generate(self,
                 convergence tolerance, etc.).
 
         Returns:
-            Xarray Dataset of output vector and (if return_tlm=True)
-                Xarray DataArray of TLMs corresponding to the system trajectory.
+            Xarray Dataset of output vector, and if return_tlm=True
+            Xarray DataArray of TLMs corresponding to the system trajectory.
         """
 
         # Check that n_steps or t_final is supplied
@@ -294,7 +292,7 @@ def rhs_aux(self,
           t: Array of times with size (time_dim)
 
         Returns:
-            State vector [size: (system_dim,)]
+            State vector of size (system_dim,)
         """
         # Compute M
         dxdt = self.rhs(x[:self.system_dim], t)
@@ -351,7 +349,7 @@ def calc_lyapunov_exponents_series(
 
         Returns:
             Lyapunov exponents for all timesteps, array of size
-                (total_time/rescale_time - 1, system_dim)
+            (total_time/rescale_time - 1, system_dim)
         """
         # Set total_time
         if total_time is None: