Skip to content

Commit 58ef4a7

Browse files
committed
Add package docstrings to __init__.py files
1 parent 95b667d commit 58ef4a7

File tree

11 files changed

+29
-1
lines changed

11 files changed

+29
-1
lines changed

pysteps/cascade/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1+
"""Methods for constructing bandpass filters and decomposing 2d precipitation
2+
fields into different spatial scales."""
13

24
from .interface import get_method

pysteps/extrapolation/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
"""Methods for advection-based extrapolation of precipitation fields. Currently
2+
the module contains an implementation of the semi-Lagrangian method described
3+
in :cite:`GZ2002`."""
14

25
from .interface import get_method

pysteps/io/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
"""Methods for browsing data archives, reading 2d precipitation fields and writing
2+
forecasts into files."""
3+
14
from .interface import get_method
25
from .archive import *
36
from .exporters import *

pysteps/motion/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1+
"""Implementations of optical flow methods."""
12

23
from .interface import get_method

pysteps/noise/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
"""Methods for generating stochastic perturbations of 2d precipitation and velocity
2+
fields."""
3+
14
from .interface import get_method
25
from . import utils

pysteps/nowcasts/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1+
"""Implementations of nowcasting methods. Currently the module contains a
2+
deterministic advection extrapolation method and STEPS."""
13

24
from .interface import get_method

pysteps/postprocessing/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1+
"""Methods for post-processing of forecasts. Currently the module contains
2+
cumulative density function (CDF)-based matching between a forecast and the
3+
target distribution and computation of mean value and exceedance probabilities
4+
from forecast ensembles."""
5+
16
from . import ensemblestats

pysteps/timeseries/__init__.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
1+
"""Methods and models for time series analysis. Currently the module contains
2+
implementation of an autoregressive AR(p) model and methods for estimating
3+
the model parameters."""

pysteps/utils/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
"""Utility functions for converting data values to/from different units,
2+
manipulating the dimensions of precipitation fields and computing the FFT."""
3+
14
from .arrays import *
25
from .conversion import *
36
from .dimension import *

pysteps/verification/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Methods for verification of deterministic and ensemble forecasts."""
2+
13
from .interface import get_method
24
from .detcatscores import *
35
from .detcontscores import *

0 commit comments

Comments
 (0)