Skip to content

weather_utils

The module for weather utility functions.

hash_series(series)

Calculate a unique hash for each input series. Used for grouping nodes by weather time series.

Parameters:

Name Type Description Default
series Iterable[float32]

The list or array of float values.

 required

Returns:

Type Description
int

Series hash value as int.
Source code in emodpy_malaria/weather/weather_utils.py 
60
61
62
63
64
65
66
67
68
69
70
71
def hash_series(series: Iterable[np.float32]) -> int:
    """
    Calculate a unique hash for each input series. Used for grouping nodes by weather time series.

    Args:
        series: The list or array of float values.

    Returns:
        Series hash value as int.
    """
    h = hash(np.array(series).tobytes())
    return h

invert_dict(in_dict, sort=False, single_value=False)

Invert a dictionary by grouping keys by value. In the resulting dictionary keys are unique value from the original dictionary (including individual element of value lists) and values are lists of original dictionary keys. The function is used for grouping nodes by offset or weather time series hash, and determining unique series.

For example, single_value = False (default) {1: [11, 22], 2: [22], 3: [11]} -> {11: [1, 3], 22: [1, 2]} single_value = True {1: [11, 22], 2: [22], 3: [11]} -> {11: 1, 22: 1}

Parameters:

Name Type Description Default
in_dict dict

Input dictionary to be inverted.

 required
sort bool

Sort the resulting dictionary by key and value.

 False
single_value bool

Only return a single representative "original key" (from in_dict) for each corresponding unique "original value" (from in_dict).

 False

Returns:

Type Description
Dict

Inverted dictionary where (single_value = False): keys are "original values" and values are lists of corresponding "original keys" (single_value = True): keys are "original values" and values is a single representative "original key".
Source code in emodpy_malaria/weather/weather_utils.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def invert_dict(in_dict: dict, sort: bool = False, single_value: bool = False) -> Dict:
    """
    Invert a dictionary by grouping keys by value. In the resulting dictionary keys are unique value from the original
    dictionary (including individual element of value lists) and values are lists of original dictionary keys.
    The function is used for grouping nodes by offset or weather time series hash, and determining unique series.

    For example,
        single_value = False (default)
            {1: [11, 22], 2: [22], 3: [11]} -> {11: [1, 3], 22: [1, 2]}
        single_value = True
            {1: [11, 22], 2: [22], 3: [11]} -> {11: 1, 22: 1}

    Args:
        in_dict: Input dictionary to be inverted.
        sort: Sort the resulting dictionary by key and value.
        single_value: Only return a single representative "original key" (from in_dict)
                        for each corresponding unique "original value" (from in_dict).

    Returns:
        Inverted dictionary where
            (single_value = False): keys are "original values" and values are lists of corresponding "original keys"
            (single_value = True):  keys are "original values" and values is a single representative "original key".
    """
    # Init the output dictionary to be able to collect original dictionary keys per value element.
    out_dict = defaultdict(list)
    # For each unique value append the corresponding key.
    for k, v in in_dict.items():
        if isinstance(v, Iterable):
            # In case original dictionary values are lists.
            for vv in v:
                out_dict[vv].append(k)
        else:
            # In case the original dictionary value are not lists.
            out_dict[v].append(k)

    if single_value:
        # Transform the output dictionary to only take have a single value (instead od a list, for each value).
        out_dict = {k: None if len(v) == 0 else v[0] for k, v in out_dict.items()}

    if sort:
        # Ensure the output  dictionary is sorted by key, value.
        out_dict = {k: sorted(v) for k, v in sorted(out_dict.items())}

    return dict(out_dict)       # Convert from defaultdict to a regular dictionary

make_path(dir_path)

Make path directories.

Source code in emodpy_malaria/weather/weather_utils.py 
86
87
88
89
def make_path(dir_path: Union[str, Path]) -> NoReturn:
    """Make path directories."""
    if dir_path:
        Path(dir_path).mkdir(exist_ok=True, parents=True)

save_json(content, file_path)

Save dictionary to a json file.

Parameters:

Name Type Description Default
content Dict[str, str]

Content in the form of a dictionary.

 required
file_path Union[str, Path]

The path of the output weather metadata file.

 required
Source code in emodpy_malaria/weather/weather_utils.py 
74
75
76
77
78
79
80
81
82
83
def save_json(content: Dict[str, str], file_path: Union[str, Path]) -> NoReturn:
    """
    Save dictionary to a json file.

    Args:
        content: Content in the form of a dictionary.
        file_path: The path of the output weather metadata file.
    """
    with open(str(file_path), "wt") as file:
        json.dump(content, file, indent=2, separators=(",", ": "))

validate_str_value(value)

Assert a string value is not None or empty.

Source code in emodpy_malaria/weather/weather_utils.py 
118
119
120
def validate_str_value(value: str) -> NoReturn:
    """Assert a string value is not None or empty."""
    assert value, "Value name must be specified."

ymd(date_arg)

Convert datetime into a string of format yyyymmdd.

Source code in emodpy_malaria/weather/weather_utils.py 
92
93
94
def ymd(date_arg: datetime) -> str:
    """Convert datetime into a string of format yyyymmdd."""
    return date_arg.strftime("%Y%m%d")