Skip to content

Commit 7a7ba61

Browse files
committed
Docstring citation fixes
1 parent 37ca2f5 commit 7a7ba61

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

pysteps/noise/motion.py

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,10 @@
2626

2727
def initialize_bps(V, pixelsperkm, timestep, p_pert_par=(10.88,0.23,-7.68),
2828
p_pert_perp=(5.76,0.31,-2.72), randstate=np.random, seed=None):
29-
"""Initialize the motion field perturbator described in Bowler et al.
30-
2006: STEPS: A probabilistic precipitation forecasting scheme which merges
31-
an extrapolation nowcast with downscaled NWP. For simplicity, the bias
32-
adjustment procedure described in the above reference has not been
29+
"""Initialize the motion field perturbator described in :cite:`BPS2006`.
30+
For simplicity, the bias adjustment procedure described there has not been
3331
implemented. The perturbator generates a constant field whose magnitude
34-
depends on lead time, see generate_motion_perturbations_bps.
32+
depends on lead time.
3533
3634
Parameters
3735
----------
@@ -42,12 +40,12 @@ def initialize_bps(V, pixelsperkm, timestep, p_pert_par=(10.88,0.23,-7.68),
4240
Tuple containing the parameters a,b and c for the standard deviation of
4341
the perturbations in the direction parallel to the motion vectors. The
4442
standard deviations are modeled by the function f_par(t) = a*t^b+c, where
45-
t is lead time. The default values are taken from Bowler et al. 2006.
43+
t is lead time. The default values are taken from :cite:`BPS2006`.
4644
p_pert_perp : tuple
4745
Tuple containing the parameters a,b and c for the standard deviation of
4846
the perturbations in the direction perpendicular to the motion vectors.
4947
The standard deviations are modeled by the function f_par(t) = a*t^b+c,
50-
where t is lead time. The default values are taken from Bowler et al. 2006.
48+
where t is lead time. The default values are taken from :cite:`BPS2006`.
5149
pixelsperkm : float
5250
Spatial resolution of the motion field (pixels/kilometer).
5351
timestep : float
@@ -62,6 +60,11 @@ def initialize_bps(V, pixelsperkm, timestep, p_pert_par=(10.88,0.23,-7.68),
6260
out : dict
6361
A dictionary containing the perturbator that can be supplied to
6462
generate_motion_perturbations_bps.
63+
64+
See also
65+
--------
66+
pysteps.noise.motion.generate_bps
67+
6568
"""
6669
if len(V.shape) != 3:
6770
raise ValueError("V is not a three-dimensional array")
@@ -117,6 +120,11 @@ def generate_bps(perturbator, t):
117120
out : ndarray
118121
Array of shape (2,m,n) containing the x- and y-components of the motion
119122
vector perturbations, where m and n are determined from the perturbator.
123+
124+
See also
125+
--------
126+
pysteps.noise.motion.initialize_bps
127+
120128
"""
121129
vsf = perturbator["vsf"]
122130
p_par = perturbator["p_par"]

0 commit comments

Comments
 (0)