Skip to content

Commit 5075b6b

Browse files
committed
Add see also sections to docstrings
1 parent 86be335 commit 5075b6b

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

pysteps/nowcasts/extrapolation.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ def forecast(R, V, num_timesteps, extrap_method="semilagrangian", extrap_kwargs=
2121
Other Parameters
2222
----------------
2323
extrap_method : {'semilagrangian'}
24-
Name of the extrapolation method to use. See the documentation of the
25-
advection module.
24+
Name of the extrapolation method to use. See the documentation of
25+
pysteps.advection.interface.
2626
extrap_kwargs : dict
2727
Optional dictionary that is supplied as keyword arguments to the
2828
extrapolation method.
@@ -32,6 +32,10 @@ def forecast(R, V, num_timesteps, extrap_method="semilagrangian", extrap_kwargs=
3232
out : ndarray
3333
Three-dimensional array of shape (num_timesteps,m,n) containing a time
3434
series of nowcast precipitation fields.
35+
36+
See also
37+
--------
38+
pysteps.advection.interface
3539
"""
3640
_check_inputs(R, V)
3741

pysteps/nowcasts/steps.py

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ def forecast(R, V, n_timesteps, n_ens_members, n_cascade_levels, R_thr=None,
5555
not None or mask_method is 'incremental'.
5656
extrap_method : {'semilagrangian'}
5757
Name of the extrapolation method to use. See the documentation of
58-
pysteps.advection.
58+
pysteps.advection.interface.
5959
decomp_method : {'fft'}
6060
Name of the cascade decomposition method to use. See the documentation
61-
of pysteps.cascade.decomposition.
61+
of pysteps.cascade.interface.
6262
bandpass_filter_method : {'gaussian', 'uniform'}
6363
Name of the bandpass filter method to use with the cascade decomposition.
64-
See the documentation of pysteps.cascade.bandpass_filters.
64+
See the documentation of pysteps.cascade.interface.
6565
noise_method : {'parametric','nonparametric','ssft','nested'}
6666
Name of the noise generator to use for perturbating the precipitation
6767
field. See the documentation of pysteps.noise.interface.
@@ -113,12 +113,10 @@ def forecast(R, V, n_timesteps, n_ens_members, n_cascade_levels, R_thr=None,
113113
filter method.
114114
noise_kwargs : dict
115115
Optional dictionary that is supplied as keyword arguments to the
116-
initializer of the noise generator. See the documentation of
117-
pysteps.noise.fftgenerators.
116+
initializer of the noise generator.
118117
vel_pert_kwargs : dict
119118
Optional dictionary that is supplied as keyword arguments to the
120-
initializer of the velocity perturbator. See the documentation of
121-
pysteps.noise.motion.
119+
initializer of the velocity perturbator.
122120
123121
Returns
124122
-------
@@ -128,6 +126,11 @@ def forecast(R, V, n_timesteps, n_ens_members, n_cascade_levels, R_thr=None,
128126
precipitation fields for each ensemble member. Otherwise, a None value
129127
is returned.
130128
129+
See also
130+
--------
131+
pysteps.advection.interface, pysteps.cascade.interface,
132+
pysteps.noise.interface, pysteps.noise.utils.compute_noise_stddev_adjs
133+
131134
References
132135
----------
133136
:cite:`Seed2003`, :cite:`BPS2006`, :cite:`SPN2013`

0 commit comments

Comments
 (0)