Skip to content

Commit

Permalink
doc, fix: get_spatial_bc_presrat()
Browse files Browse the repository at this point in the history
Returning too many variables. Better do it at least groupped in a
dictionary.
  • Loading branch information
castelao committed Jul 15, 2024
1 parent f0f9392 commit 214e5d3
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions sup3r/bias/bias_transforms.py
Original file line number Diff line number Diff line change
Expand Up @@ -636,24 +636,26 @@ def get_spatial_bc_presrat(lat_lon: np.array,
Returns
-------
base : np.array
Parameters used to define the statistical distribution estimated for
the ``base_dset``. It has a shape of (I, J, P), where (I, J) are the
same first two dimensions of the given `lat_lon` and P is the number
of parameters and depends on the type of distribution. See
:class:`~sup3r.bias.PresRat` for more details.
bias : np.array
Parameters used to define the statistical distribution estimated for
(historical) ``feature_name``. It has a shape of (I, J, P), where
(I, J) are the same first two dimensions of the given `lat_lon` and P
is the number of parameters and depends on the type of distribution.
See :class:`~sup3r.bias.PresRat` for more details.
bias_fut : np.array
Parameters used to define the statistical distribution estimated for
(future) ``feature_name``. It has a shape of (I, J, P), where (I, J)
are the same first two dimensions of the given `lat_lon` and P is the
number of parameters used and depends on the type of distribution. See
:class:`~sup3r.bias.PresRat` for more details.
dict :
A dictionary containing:
- base : np.array
Parameters used to define the statistical distribution estimated for
the ``base_dset``. It has a shape of (I, J, P), where (I, J) are the
same first two dimensions of the given `lat_lon` and P is the number
of parameters and depends on the type of distribution. See
:class:`~sup3r.bias.PresRat` for more details.
- bias : np.array
Parameters used to define the statistical distribution estimated for
(historical) ``feature_name``. It has a shape of (I, J, P), where
(I, J) are the same first two dimensions of the given `lat_lon` and P
is the number of parameters and depends on the type of distribution.
See :class:`~sup3r.bias.PresRat` for more details.
- bias_fut : np.array
Parameters used to define the statistical distribution estimated for
(future) ``feature_name``. It has a shape of (I, J, P), where (I, J)
are the same first two dimensions of the given `lat_lon` and P is the
number of parameters used and depends on the type of distribution.
See :class:`~sup3r.bias.PresRat` for more details.
cfg : dict
Metadata used to guide how to use of the previous parameters on
reconstructing the statistical distributions. For instance,
Expand Down

0 comments on commit 214e5d3

Please sign in to comment.