Docstring and whitespace fixes

Author: pulkkins

pysteps/advection/interface.py

@@ -12,8 +12,7 @@
 method are passed as a dictionary.
 
 The output of each method is an array R_e that includes the time series of extrapolated 
-fields of shape (num_timesteps, m, n). 
-"""
+fields of shape (num_timesteps, m, n)."""
 
 def get_method(name):
     """Return a callable function for the extrapolation method corresponding to 
@@ -30,6 +29,7 @@ def get_method(name):
     |  semilagrangian   | implementation of the semi-Lagrangian method of        |
     |                   | Germann et al. (2002)                                  |
     +-------------------+--------------------------------------------------------+
+    
     """
     if name is None:
         def donothing(R, V, num_timesteps, *args, **kwargs):

pysteps/cascade/bandpass_filters.py

@@ -49,6 +49,7 @@ def filter_uniform(shape, n):
         it assumes to be a square domain.
     n : int
         Not used. Needed for compatibility with the filter interface.
+    
     """
     result = {}
 
@@ -195,4 +196,3 @@ def g(x):
     central_freqs.append(l/2)
 
     return weight_funcs, central_freqs
-    

pysteps/cascade/decomposition.py

@@ -62,6 +62,7 @@ def decomposition_fft(X, filter, **kwargs):
     out : ndarray
       A dictionary described in the module documentation. The parameter n is 
       determined from the filter (see bandpass_filters.py).
+    
     """
     MASK = kwargs.get("MASK", None)
 

pysteps/io/archive.py

@@ -37,6 +37,7 @@ def find_by_date(date, root_path, path_fmt, fn_pattern, fn_ext, timestep,
         object. Otherwise, return a tuple of two lists, the first one for the 
         file names and the second one for the correspondign timestemps. The lists 
         are sorted in ascending order with respect to timestamp.
+    
     """
     filenames  = []
     timestamps = []

pysteps/io/importers.py

@@ -101,6 +101,7 @@ def import_bom_rf3(filename, **kwargs):
         A three-element tuple containing the rainfall field in mm/h imported
         from the Bureau RF3 netcdf, the quality field and the metadata. The
         quality field is currently set to None.
+    
     """
     if not netcdf4_imported:
         raise Exception("netCDF4 not imported")
@@ -214,6 +215,7 @@ def import_fmi_pgm(filename, **kwargs):
         A three-element tuple containing the reflectivity composite in dBZ
         and the associated quality field and metadata. The quality field is
         currently set to None.
+    
     """
     if not pyproj_imported:
         raise Exception("pyproj not imported")
@@ -337,6 +339,7 @@ def import_mch_gif(filename, **kwargs):
         A three-element tuple containing the precipitation field in mm/h imported
         from a MeteoSwiss gif file and the associated quality field and metadata.
         The quality field is currently set to None.
+    
     """
     if not pil_imported:
         raise Exception("PIL not imported")
@@ -460,6 +463,7 @@ def import_odim_hdf5(filename, **kwargs):
         quantity and the associated quality field and metadata. The quality
         field is read from the file if it contains a dataset whose quantity
         identifier is 'QIND'.
+    
     """
     if not h5py_imported:
         raise Exception("h5py not imported")

pysteps/io/readers.py

@@ -20,6 +20,7 @@ def read_timeseries(inputfns, importer, **kwargs):
     out : tuple
         A three-element tuple containing the precipitation fields read, the quality fields,
         and associated metadata.
+    
     """
 
     # check for missing data

pysteps/noise/utils.py

@@ -1,4 +1,4 @@
-"""Miscellaneous utility functions related to generating stochastic perturbations."""
+"""Miscellaneous utility functions related to generation of stochastic perturbations."""
 
 import numpy as np
 try:
@@ -66,6 +66,7 @@ def compute_noise_stddev_adjs(R, R_thr_1, R_thr_2, F, decomp_method, num_iter,
     out : list
         A list containing the standard deviation adjustment factor for each 
         cascade level.
+    
     """
 
     MASK = R >= R_thr_1

pysteps/nowcasts/extrapolation.py

@@ -36,6 +36,7 @@ def forecast(R, V, num_timesteps, extrap_method="semilagrangian", extrap_kwargs=
     See also
     --------
     pysteps.advection.interface
+    
     """
     _check_inputs(R, V)
 

pysteps/nowcasts/steps.py

@@ -23,8 +23,8 @@ def forecast(R, V, n_timesteps, n_ens_members, n_cascade_levels, R_thr=None,
              use_probmatching=True, mask_method="incremental", callback=None, 
              return_output=True, seed=None, num_workers=None, extrap_kwargs={}, 
              filter_kwargs={}, noise_kwargs={}, vel_pert_kwargs={}):
-    """Generate a nowcast ensemble by using the STEPS method described in 
-    :cite:`Seed2003`, :cite:`BPS2006` and :cite:`SPN2013`.
+    """Generate a nowcast ensemble by using the Short-Term Ensemble Prediction 
+    System (STEPS) method.
     
     Parameters
     ----------

pysteps/optflow/interface.py

@@ -30,6 +30,7 @@ def get_method(name):
     |                   | method of Bruhn et al., 2005 from IPOL                 |
     |                   | (http://www.ipol.im/pub/art/2015/44)                   |
     +-------------------+--------------------------------------------------------+
+    
     """
     if name is None:
         def donothing(R, *args, **kwargs):