Merge branch 'master' of https://github.com/pySTEPS/pysteps

Author: dnerini

doc/source/advection.rst

@@ -3,6 +3,10 @@
 Advection-based extrapolation (:mod:`pysteps.advection`)
 ********************************************************
 
+Methods for advection-based extrapolation of precipitation fields. Currently 
+the module contains an implementation of the semi-Lagrangian method described 
+in :cite:`GZ2002`.
+
 pysteps\.advection\.interface
 -----------------------------
 

doc/source/cascade.rst

@@ -3,6 +3,9 @@
 Scale-based decomposition of precipitation fields (:mod:`pysteps.cascade`)
 **************************************************************************
 
+Methods for band-pass filtering and scale-based decomposition of 2d precipitation 
+fields.
+
 pysteps.cascade.interface
 -------------------------
 

doc/source/io.rst

@@ -3,6 +3,9 @@
 Input/output routines (:mod:`pysteps.io`)
 *****************************************
 
+Methods for browsing data archives, reading 2d precipitation fields and writing 
+forecasts into files.
+
 pysteps\.io\.interface
 ----------------------
 

doc/source/noise.rst

@@ -3,6 +3,9 @@
 Noise generators (:mod:`pysteps.noise`)
 ***************************************
 
+Methods for generating stochastic perturbations of 2d precipitation and velocity 
+fields.
+
 pysteps\.noise\.interface
 -------------------------
 

doc/source/nowcasting.rst

@@ -3,6 +3,9 @@
 Nowcasting methods (:mod:`pysteps.nowcasts`)
 ********************************************
 
+Implementations of nowcasting methods. Currently the module contains a 
+deterministic advection extrapolation method and STEPS.
+
 pysteps\.nowcasts\.interface
 ----------------------------
 

doc/source/oflow.rst

@@ -3,6 +3,8 @@
 Optical flow methods (:mod:`pysteps.optflow`)
 *********************************************
 
+Implementations of optical flow methods.
+
 pysteps\.optflow\.interface
 ---------------------------
 

doc/source/postprocessing.rst

@@ -3,6 +3,10 @@
 Post-processing of forecasts (:mod:`pysteps.postproc`)
 ******************************************************
 
+Methods for post-processing of forecasts. Currently the module contains 
+cumulative density function (CDF)-based matching between a forecast and the 
+target distribution.
+
 pysteps\.postproc\.probmatching
 -------------------------------
 

doc/source/timeseries.rst

@@ -3,6 +3,10 @@
 Time series modeling and analysis (:mod:`pysteps.timeseries`)
 *************************************************************
 
+Methods and models for time series analysis. Currently the module contains 
+implementation of an autoregressive AR(p) model and methods for estimating 
+the model parameters.
+
 pysteps\.timeseries\.autoregression
 -----------------------------------
 

doc/source/utils.rst

@@ -3,14 +3,17 @@
 Miscellaneous utility functions (:mod:`pysteps.utils`)
 ******************************************************
 
+Utility functions for converting data values to/from different units and 
+manipulating the dimensions of precipitation fields.
+
 pysteps\.utils\.conversion
 --------------------------
 
 .. currentmodule:: pysteps.utils.conversion
 
 .. autosummary::
     to_rainrate
-    to_raindetph
+    to_raindepth
     to_reflectivity
 
 .. automodule:: pysteps.utils.conversion

doc/source/verification.rst

@@ -3,13 +3,15 @@
 Forecast verification (:mod:`pysteps.verification`)
 ***************************************************
 
+Methods for verification of deterministic and ensemble forecasts.
+
 pysteps\.verification\.detcatscores
 -----------------------------------
 
 .. currentmodule:: pysteps.verification.detcatscores
 
 .. autosummary::
-    scores_det_cont_fsct
+    scores_det_cat_fcst
 
 .. automodule:: pysteps.verification.detcatscores
     :members:
@@ -20,7 +22,7 @@ pysteps\.verification\.detcontscores
 .. currentmodule:: pysteps.verification.detcontscores
 
 .. autosummary::
-    scores_det_cont_fsct
+    scores_det_cont_fcst
 
 .. automodule:: pysteps.verification.detcontscores
     :members: