Updated data classes docstrings to clarify parameters vs. attributes

Author: kysolvik

dabench/data/_barotropic.py

@@ -43,7 +43,7 @@ class Barotropic(_data.Data):
             vortices in turbulent flow. Journal of Fluid Mechanics, 146,
             pp 21-43 doi:10.1017/S0022112084001750.
 
-    Attributes:
+    Args:
         system_dim: system dimension
         beta: Gradient of coriolis parameter. Units: meters^-1 *
             seconds^-1. Default is 0.

dabench/data/_data.py

@@ -18,7 +18,7 @@
 class Data():
     """Generic class for data generator objects.
 
-    Attributes:
+    Args:
         system_dim: system dimension
         time_dim: total time steps
         original_dim: dimensions in original space, e.g. could be 3x3

dabench/data/_enso_indices.py

@@ -19,7 +19,7 @@ class ENSOIndices(_data.Data):
     Notes:
         Source: https://www.cpc.ncep.noaa.gov/data/indices/
 
-    Attributes:
+    Args:
         system_dim: system dimension
         time_dim: total time steps
         store_as_jax: Store values as jax array instead of numpy array.

dabench/data/_gcp.py

@@ -24,7 +24,7 @@ class GCP(_data.Data):
         Source: https://cloud.google.com/storage/docs/public-datasets/era5
         Data is hourly
 
-    Attributes:
+    Args:
         variables: Names of ERA5 variables to
             load. For description of variables, see:
             https://github.com/google-research/arco-era5?tab=readme-ov-file#full_37-1h-0p25deg-chunk-1zarr-v3

dabench/data/_lorenz63.py

@@ -15,7 +15,7 @@
 class Lorenz63(_data.Data):
     """ Class to set up Lorenz 63 model data
 
-    Attributes:
+    Args:
         sigma: Lorenz 63 param. Default is 10., the original value
             used in Lorenz, 1963.
             https://doi.org/10.1175/1520-0469(1963)020<0130:DNF>2.0.CO;2

dabench/data/_lorenz96.py

@@ -19,7 +19,7 @@ class Lorenz96(_data.Data):
         Default values come from Lorenz, 1996:
         eapsweb.mit.edu/sites/default/files/Predicability_a_Problem_2006.pdf
 
-    Attributes:
+    Args:
         forcing_term: Forcing constant for Lorenz96, prevents energy
             from decaying to 0. Default is 8.0.
         x0: Initial state vector, array of floats of size

dabench/data/_pyqg.py

@@ -34,7 +34,7 @@ class PyQG(_data.Data):
         Uses default attribute values from pyqg.QGModel:
         https://pyqg.readthedocs.io/en/latest/api.html#pyqg.QGModel
 
-    Attributes:
+    Args:
         beta (float): Gradient of coriolis parameter. Units: meters^-1 *
             seconds^-1
         rek (float): Linear drag in lower layer. Units: seconds^-1
@@ -47,7 +47,7 @@ class PyQG(_data.Data):
         ny (int): Number of grid points in the y direction (default: nx).
         L (float): Domain length in x direction. Units: meters.
         W (float): Domain width in y direction. Units: meters (default: L).
-        filterfac (float): amplitdue of the spectral spherical filter
+        filterfac (float): amplitude of the spectral spherical filter
             (originally 18.4, later changed to 23.6).
         delta_t (float): Numerical timestep. Units: seconds.
         twrite (int): Interval for cfl writeout. Units: number of timesteps.

dabench/data/_pyqg_jax.py

@@ -41,7 +41,7 @@ class PyQGJax(_data.Data):
         Uses default attribute values from pyqg_jax.QGModel:
         https://pyqg.readthedocs.io/en/latest/api.html#pyqg.QGModel
 
-    Attributes:
+    Args:
         beta: Gradient of coriolis parameter. Units: meters^-1 *
             seconds^-1
         rd: Deformation radius. Units: meters.

dabench/data/_qgs.py

@@ -38,7 +38,7 @@ class QGS(_data.Data):
     The QGS class is simply a wrapper of an *optional* qgs package.
     See https://qgs.readthedocs.io/
 
-    Attributes:
+    Args:
         model_params: qgs parameter object. See:
             https://qgs.readthedocs.io/en/latest/files/technical/configuration.html#qgs.params.params.QgParams
             If None, will use defaults specified by:

dabench/data/_sqgturb.py

@@ -52,7 +52,7 @@
 class SQGTurb(_data.Data):
     """Class to set up SQGTurb model and manage data.
 
-    Attributes:
+    Args:
         pv: Potential vorticity array. If None (default),
              loads data from 57600 step spinup with initial conditions taken
              from Jeff Whitaker's original implementation: