improver.nbhood package

Submodules

• improver.nbhood.circular_kernel module
• improver.nbhood.nbhood module
• improver.nbhood.recursive_filter module
• improver.nbhood.square_kernel module
• improver.nbhood.use_nbhood module

Module contents

init for nbhood

improver.nbhood.radius_by_lead_time(radii, lead_times)

Parse radii and lead_times provided to CLIs that use neighbourhooding. If no lead times are provided, return the first radius for use at all lead times. If lead times are provided, ensure there are sufficient radii to assign one to each lead time. If so return two lists, else raise an exception.

Parameters

• radii (list of str) – Radii as a list provided by clize.

• lead_times (list of str or None) – Lead times as a list provided by clize, or None if not set.

Returns

tuple containing:

radius_or_radii (float or list of floats):

Radii as a float or list of floats.

lead_times (None or list of ints):

Lead times in hours as a list of ints or None.

Return type

(tuple)

Raises

• ValueError – If multiple radii are provided without any lead times.

• ValueError – If radii and lead_times lists are on unequal lengths.