Add rescaling to daily HR capabilities due to either a constant factor or pop grown

Author: marghe-molaro

resources/healthsystem/ResourceFile_HealthSystem_parameters.csv

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:187302cf1744ee6a9538665c5dff5650f58e4d00c8d74844ff8b569b6b38f9d1
-size 335
+oid sha256:1cc35f571076244f7bb0ee964ad4c44d57d4943dc35b044302b98de6b0f4b0b6
+size 391

src/tlo/methods/healthsystem.py

@@ -554,6 +554,15 @@ class HealthSystem(Module):
                           "and custom (user can freely set these factors as parameters in the analysis).",
         ),
 
+        'dynamic_HR_scaling_factor': Parameter(
+            Types.REAL, "Factor by which HR capabilities are scaled at regular intervals of 1 year"
+        ),
+        
+        'scale_HR_by_popsize': Parameter(
+            Types.BOOL, "Decide whether to scale HR capabilities by population size every year. Can be used in addition to"
+                        "dynamic_HR_scaling_factor"
+        ),
+
         'tclose_overwrite': Parameter(
             Types.INT, "Decide whether to overwrite tclose variables assigned by disease modules"),
 
@@ -904,6 +913,12 @@ def initialise_simulation(self, sim):
         sim.schedule_event(HealthSystemChangeMode(self),
                            Date(self.parameters["year_mode_switch"], 1, 1))
 
+        # Schedule recurring event which will rescale daily capabilities at regular intervals.
+        # Note: if want to use Demography's popsize_by_year for current year too (see options in DynamicRescalingHRCapabilities),
+        # need to ensure that the DynamicRescalingHRCapabilities event takes place *after* the DemographyLoggerEvent has been called.
+        # Could achieve this for example by scheduling the former to happen on 2nd of Feb..
+        sim.schedule_event(DynamicRescalingHRCapabilities(self), Date(sim.date+DateOffset(years=1)))
+
     def on_birth(self, mother_id, child_id):
         self.bed_days.on_birth(self.sim.population.props, mother_id, child_id)
 
@@ -2842,6 +2857,29 @@ def apply(self, population):
             self.module.bed_days.availability = self._parameters['beds_availability']
 
 
+class DynamicRescalingHRCapabilities(RegularEvent, PopulationScopeEventMixin):
+    """ This event exists to scale the daily capabilities assumed at fixed time intervals"""
+    def __init__(self, module):
+        super().__init__(module, frequency=DateOffset(years=1))
+
+    def apply(self, population):
+
+        # The following assumes that self.module._daily_capabilities is initialised once at start of simulation,
+        # which I believe is correct
+        
+        # Rescale daily capabilities by specified amount
+        self.module._daily_capabilities *= self.module.parameters['dynamic_HR_scaling_factor']
+
+        # Rescale daily capabilities by population size, if this option is included
+        if self.module.parameters['scale_HR_by_popsize']:
+            demog = self.sim.modules['Demography']
+            if self.sim.date.year>2010:
+                # Either
+                self.module._daily_capabilities *= population.props.is_alive.sum()/demog.popsize_by_year[self.sim.date.year - 1]
+                # Or, if ensuring DemographyLoggingEvent at start of the year takes place *before* this rescaling
+                # self.module._daily_capabilities *= demog.popsize_by_year[self.sim.date.year]/demog.popsize_by_year[self.sim.date.year - 1]
+
+
 class HealthSystemChangeMode(RegularEvent, PopulationScopeEventMixin):
     """ This event exists to change the priority policy adopted by the
     HealthSystem at a given year.    """