vivarium-public-health 2.3.0__tar.gz → 2.3.2__tar.gz

{vivarium_public_health-2.3.0 → vivarium_public_health-2.3.2}/CHANGELOG.rst

@@ -1,3 +1,12 @@
+**2.3.2 - 3/13/24**
+
+ - Update to Mortality Observer to make subclassing easier.
+
+**2.3.1 - 3/11/24**
+
+ - Update Mortality Observer to include tracked in population filter
+ - Fix bug in get_initialization_parameters to only remove existing keys if necessary
+
 **2.3.0 - 3/7/24**
 
  - Update population configuration keys to be more descriptive

{vivarium_public_health-2.3.0 → vivarium_public_health-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vivarium_public_health
-Version: 2.3.0
+Version: 2.3.2
 Summary: Components for modelling diseases, risks, and interventions with ``vivarium``
 Home-page: https://github.com/ihmeuw/vivarium_public_health
 Author: The vivarium developers

vivarium_public_health-2.3.2/src/vivarium_public_health/_version.py

@@ -0,0 +1 @@
+__version__ = "2.3.2"

{vivarium_public_health-2.3.0 → vivarium_public_health-2.3.2}/src/vivarium_public_health/disease/state.py

@@ -85,8 +85,9 @@ class BaseDiseaseState(State):
     def get_initialization_parameters(self) -> Dict[str, Any]:
         """Exclude side effect function and cause type from name and __repr__."""
         initialization_parameters = super().get_initialization_parameters()
-        del initialization_parameters["side_effect_function"]
-        del initialization_parameters["cause_type"]
+        for key in ["side_effect_function", "cause_type"]:
+            if key in initialization_parameters.keys():
+                del initialization_parameters[key]
         return initialization_parameters
 
     def get_initial_event_times(self, pop_data: SimulantData) -> pd.DataFrame:

{vivarium_public_health-2.3.0 → vivarium_public_health-2.3.2}/src/vivarium_public_health/metrics/mortality.py

@@ -54,6 +54,17 @@ class MortalityObserver(Component):
         }
     }
 
+    def __init__(self):
+        super().__init__()
+        self.causes_of_death = ["other_causes"]
+        self.required_death_columns = ["alive", "exit_time"]
+        self.required_yll_columns = [
+            "alive",
+            "cause_of_death",
+            "exit_time",
+            "years_of_life_lost",
+        ]
+
     ##############
     # Properties #
     ##############
@@ -75,17 +86,14 @@ class MortalityObserver(Component):
     def setup(self, builder: Builder) -> None:
         self.clock = builder.time.clock()
         self.config = builder.configuration.stratification.mortality
-        self._cause_components = builder.components.get_components_by_type(
+        cause_components = builder.components.get_components_by_type(
             (DiseaseState, RiskAttributableDisease)
         )
-
+        self.causes_of_death += [
+            cause.state_id for cause in cause_components if cause.has_excess_mortality
+        ]
         if not self.config.aggregate:
-            causes_of_death = ["other_causes"] + [
-                cause.state_id
-                for cause in self._cause_components
-                if cause.has_excess_mortality
-            ]
-            for cause_of_death in causes_of_death:
+            for cause_of_death in self.causes_of_death:
                 self._register_mortality_observations(
                     builder, cause_of_death, f'cause_of_death == "{cause_of_death}"'
                 )
@@ -100,15 +108,15 @@ class MortalityObserver(Component):
         self, builder: Builder, cause: str, additional_pop_filter: str = ""
     ) -> None:
         pop_filter = (
-            'alive == "dead"'
+            'alive == "dead" and tracked == True'
             if additional_pop_filter == ""
-            else f'alive == "dead" and {additional_pop_filter}'
+            else f'alive == "dead" and tracked == True and {additional_pop_filter}'
         )
         builder.results.register_observation(
             name=f"death_due_to_{cause}",
             pop_filter=pop_filter,
             aggregator=self.count_deaths,
-            requires_columns=["alive", "exit_time"],
+            requires_columns=self.required_death_columns,
             additional_stratifications=self.config.include,
             excluded_stratifications=self.config.exclude,
             when="collect_metrics",
@@ -117,12 +125,7 @@ class MortalityObserver(Component):
             name=f"ylls_due_to_{cause}",
             pop_filter=pop_filter,
             aggregator=self.calculate_ylls,
-            requires_columns=[
-                "alive",
-                "cause_of_death",
-                "exit_time",
-                "years_of_life_lost",
-            ],
+            requires_columns=self.required_yll_columns,
             additional_stratifications=self.config.include,
             excluded_stratifications=self.config.exclude,
             when="collect_metrics",

{vivarium_public_health-2.3.0 → vivarium_public_health-2.3.2}/src/vivarium_public_health.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vivarium_public_health
-Version: 2.3.0
+Version: 2.3.2
 Summary: Components for modelling diseases, risks, and interventions with ``vivarium``
 Home-page: https://github.com/ihmeuw/vivarium_public_health
 Author: The vivarium developers

vivarium_public_health-2.3.0/src/vivarium_public_health/_version.py

@@ -1 +0,0 @@
-__version__ = "2.3.0"