Skip to content

weather_config

Climate configuration helpers for EMOD simulations.

These functions set the Climate_Model parameter and related settings on the EMOD config object. They are thin wrappers around direct parameter assignment, providing validation and sensible defaults.

set_climate_by_data(config, *, air_temperature_filename, rainfall_filename, relative_humidity_filename, update_resolution=ClimateUpdateResolution.CLIMATE_UPDATE_DAY, air_temperature_offset=0.0, air_temperature_variance=0.0, rainfall_scale_factor=1.0, enable_rainfall_stochasticity=False, relative_humidity_scale_factor=1.0, relative_humidity_variance=0.0)

Configure CLIMATE_BY_DATA mode to read weather from binary files.

EMOD reads four .bin / .bin.json file pairs for air temperature, land temperature, rainfall, and relative humidity.

Enable_Climate_Stochasticity is set automatically when any variance is non-zero or rainfall stochasticity is enabled.

Parameters:

Name Type Description Default
config object

The EMOD config object (task.config).

 required
air_temperature_filename str

Path to air temperature .bin file.

 required
rainfall_filename str

Path to rainfall .bin file.

 required
relative_humidity_filename str

Path to relative humidity .bin file.

 required
update_resolution Union[ClimateUpdateResolution, str]

Climate update frequency.

 CLIMATE_UPDATE_DAY
air_temperature_offset float

Additive offset applied to all air temperature values (Celsius).

 0.0
air_temperature_variance float

Standard deviation (Celsius) for Gaussian noise on daily air temperature. If set to 0, relative humidity does not vary from the data. Set this to > 0 to enable stochasticity.

 0.0
rainfall_scale_factor float

Multiplicative factor applied to all rainfall values.

 1.0
enable_rainfall_stochasticity bool

When True, draw daily rainfall from an exponential distribution with mean equal to the data value.

 False
relative_humidity_scale_factor float

Multiplicative factor applied to all relative humidity values.

 1.0
relative_humidity_variance float

Standard deviation (fraction) for Gaussian noise on daily relative humidity. If set to 0, relative humidity does not vary from the data. Set this to > 0 to enable stochasticity.

 0.0
Source code in emodpy_malaria/weather/weather_config.py 
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
def set_climate_by_data(config: object, *,
                        air_temperature_filename: str,
                        rainfall_filename: str,
                        relative_humidity_filename: str,
                        update_resolution: Union[ClimateUpdateResolution, str] = (
                            ClimateUpdateResolution.CLIMATE_UPDATE_DAY),
                        air_temperature_offset: float = 0.0,
                        air_temperature_variance: float = 0.0,
                        rainfall_scale_factor: float = 1.0,
                        enable_rainfall_stochasticity: bool = False,
                        relative_humidity_scale_factor: float = 1.0,
                        relative_humidity_variance: float = 0.0):
    """Configure ``CLIMATE_BY_DATA`` mode to read weather from binary files.

    EMOD reads four ``.bin`` / ``.bin.json`` file pairs for air temperature,
    land temperature, rainfall, and relative humidity.

    ``Enable_Climate_Stochasticity`` is set automatically when any
    variance is non-zero or rainfall stochasticity is enabled.

    Args:
        config (object): The EMOD config object (``task.config``).
        air_temperature_filename (str): Path to air temperature ``.bin`` file.
        rainfall_filename (str): Path to rainfall ``.bin`` file.
        relative_humidity_filename (str): Path to relative humidity ``.bin`` file.
        update_resolution (Union[ClimateUpdateResolution, str]): Climate update frequency.
        air_temperature_offset (float): Additive offset applied to all air
            temperature values (Celsius).
        air_temperature_variance (float): Standard deviation (Celsius) for
            Gaussian noise on daily air temperature.  If set to 0, relative humidity
            does not vary from the data. Set this to > 0 to enable stochasticity.
        rainfall_scale_factor (float): Multiplicative factor applied to all
            rainfall values.
        enable_rainfall_stochasticity (bool): When True, draw daily rainfall from an
            exponential distribution with mean equal to the data value.
        relative_humidity_scale_factor (float): Multiplicative factor applied to
            all relative humidity values.
        relative_humidity_variance (float): Standard deviation (fraction) for
            Gaussian noise on daily relative humidity. If set to 0, relative humidity
            does not vary from the data.
            Set this to > 0 to enable stochasticity.
    """
    if not isinstance(update_resolution, ClimateUpdateResolution):
        try:
            update_resolution = ClimateUpdateResolution(update_resolution)
        except ValueError:
            raise ValueError(
                f"Invalid update_resolution {update_resolution!r}. "
                f"Valid options: {list(ClimateUpdateResolution)}"
            )

    stochastic = (air_temperature_variance != 0.0
                  or relative_humidity_variance != 0.0
                  or enable_rainfall_stochasticity)

    config.parameters.Climate_Model = ClimateModel.CLIMATE_BY_DATA
    config.parameters.Climate_Update_Resolution = update_resolution

    config.parameters.Air_Temperature_Filename = str(air_temperature_filename)
    config.parameters.Land_Temperature_Filename = str(air_temperature_filename)
    config.parameters.Rainfall_Filename = str(rainfall_filename)
    config.parameters.Relative_Humidity_Filename = str(relative_humidity_filename)

    config.parameters.Air_Temperature_Offset = air_temperature_offset
    config.parameters.Land_Temperature_Offset = 0.0
    config.parameters.Rainfall_Scale_Factor = rainfall_scale_factor
    config.parameters.Relative_Humidity_Scale_Factor = relative_humidity_scale_factor

    config.parameters.Enable_Climate_Stochasticity = int(stochastic)
    config.parameters.Air_Temperature_Variance = air_temperature_variance
    config.parameters.Relative_Humidity_Variance = relative_humidity_variance
    config.parameters.Enable_Rainfall_Stochasticity = int(enable_rainfall_stochasticity)

    return config

set_climate_constant(config, *, air_temperature=27.0, rainfall=10.0, relative_humidity=0.75, update_resolution=ClimateUpdateResolution.CLIMATE_UPDATE_DAY, air_temperature_variance=0.0, relative_humidity_variance=0.0, enable_rainfall_stochasticity=False)

Configure CLIMATE_CONSTANT mode with user-specified base values.

EMOD uses these constant values (plus optional stochastic noise) for every node on every time step, ignoring any weather files.

Base_Land_Temperature is set equal to air_temperature — EMOD requires it but does not use it for malaria simulations.

Enable_Climate_Stochasticity is set automatically when any variance is non-zero or rainfall stochasticity is enabled.

Parameters:

Name Type Description Default
config object

The EMOD config object (task.config).

 required
air_temperature float

Base air temperature in Celsius.

 27.0
rainfall float

Base rainfall in mm/update_resolution.

 10.0
relative_humidity float

Base relative humidity (0.0 -- 1.0).

 0.75
update_resolution Union[ClimateUpdateResolution, str]

Climate update frequency.

 CLIMATE_UPDATE_DAY
air_temperature_variance float

Standard deviation (Celsius) for Gaussian noise on daily air temperature.

 0.0
relative_humidity_variance float

Standard deviation (fraction) for Gaussian noise on daily relative humidity.

 0.0
enable_rainfall_stochasticity bool

Draw daily rainfall from an exponential distribution with mean equal to the base value.

 False
Source code in emodpy_malaria/weather/weather_config.py 
13
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
58
59
60
61
62
63
64
65
66
67
68
69
def set_climate_constant(config: object, *,
                         air_temperature: float = 27.0,
                         rainfall: float = 10.0,
                         relative_humidity: float = 0.75,
                         update_resolution: Union[ClimateUpdateResolution, str] = ClimateUpdateResolution.CLIMATE_UPDATE_DAY,
                         air_temperature_variance: float = 0.0,
                         relative_humidity_variance: float = 0.0,
                         enable_rainfall_stochasticity: bool = False):
    """Configure ``CLIMATE_CONSTANT`` mode with user-specified base values.

    EMOD uses these constant values (plus optional stochastic noise) for
    every node on every time step, ignoring any weather files.

    ``Base_Land_Temperature`` is set equal to *air_temperature* — EMOD
    requires it but does not use it for malaria simulations.

    ``Enable_Climate_Stochasticity`` is set automatically when any
    variance is non-zero or rainfall stochasticity is enabled.

    Args:
        config (object): The EMOD config object (``task.config``).
        air_temperature (float): Base air temperature in Celsius.
        rainfall (float): Base rainfall in mm/**update_resolution**.
        relative_humidity (float): Base relative humidity (0.0 -- 1.0).
        update_resolution (Union[ClimateUpdateResolution, str]): Climate update frequency.
        air_temperature_variance (float): Standard deviation (Celsius) for
            Gaussian noise on daily air temperature.
        relative_humidity_variance (float): Standard deviation (fraction) for
            Gaussian noise on daily relative humidity.
        enable_rainfall_stochasticity (bool): Draw daily **rainfall** from an
            exponential distribution with mean equal to the base value.
    """
    if not isinstance(update_resolution, ClimateUpdateResolution):
        try:
            update_resolution = ClimateUpdateResolution(update_resolution)
        except ValueError:
            raise ValueError(
                f"Invalid update_resolution {update_resolution!r}. "
                f"Valid options: {list(ClimateUpdateResolution)}"
            )

    stochastic = (air_temperature_variance != 0.0
                  or relative_humidity_variance != 0.0
                  or enable_rainfall_stochasticity)

    config.parameters.Climate_Model = ClimateModel.CLIMATE_CONSTANT
    config.parameters.Climate_Update_Resolution = update_resolution
    config.parameters.Base_Air_Temperature = air_temperature
    config.parameters.Base_Land_Temperature = air_temperature
    config.parameters.Base_Rainfall = rainfall
    config.parameters.Base_Relative_Humidity = relative_humidity
    config.parameters.Enable_Climate_Stochasticity = int(stochastic)
    config.parameters.Air_Temperature_Variance = air_temperature_variance
    config.parameters.Relative_Humidity_Variance = relative_humidity_variance
    config.parameters.Enable_Rainfall_Stochasticity = int(enable_rainfall_stochasticity)

    return config