vivarium-public-health 3.1.0__py3-none-any.whl → 3.1.1__py3-none-any.whl

vivarium_public_health/_version.py

@@ -1 +1 @@
-__version__ = "3.1.0"
+__version__ = "3.1.1"

vivarium_public_health/disease/model.py

@@ -8,7 +8,8 @@ function is to provide coordination across a set of disease states and
 transitions at simulation initialization and during transitions.
 
 """
-
+import warnings
+from collections.abc import Iterable
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union
 
 import numpy as np
@@ -38,7 +39,7 @@ class DiseaseModel(Machine):
         return {
             f"{self.name}": {
                 "data_sources": {
-                    "cause_specific_mortality_rate": "self::load_cause_specific_mortality_rate"
+                    "cause_specific_mortality_rate": self.load_cause_specific_mortality_rate,
                 },
             },
         }
@@ -79,16 +80,35 @@ class DiseaseModel(Machine):
         initial_state: Optional[BaseDiseaseState] = None,
         get_data_functions: Optional[Dict[str, Callable]] = None,
         cause_type: str = "cause",
+        states: Iterable[BaseDiseaseState] = (),
+        residual_state: BaseDiseaseState | None = None,
         **kwargs,
     ):
-        super().__init__(cause, **kwargs)
+        super().__init__(cause, states=states, **kwargs)
         self.cause = cause
         self.cause_type = cause_type
 
         if initial_state is not None:
-            self.initial_state = initial_state.state_id
+            warnings.warn(
+                "In the future, the 'initial_state' argument to DiseaseModel"
+                " will be used to initialize all simulants into that state. To"
+                " retain the current behavior of defining a residual state, use"
+                " the 'residual_state' argument.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
+            if residual_state:
+                raise DiseaseModelError(
+                    "A DiseaseModel cannot be initialized with both"
+                    " 'initial_state and 'residual_state'."
+                )
+
+            self.residual_state = initial_state.state_id
+        elif residual_state is not None:
+            self.residual_state = residual_state.state_id
         else:
-            self.initial_state = self._get_default_initial_state()
+            self.residual_state = self._get_default_residual_state()
 
         self._get_data_functions = (
             get_data_functions if get_data_functions is not None else {}
@@ -135,7 +155,7 @@ class DiseaseModel(Machine):
     def on_initialize_simulants(self, pop_data: SimulantData) -> None:
         population = self.population_view.subview(["age", "sex"]).get(pop_data.index)
 
-        assert self.initial_state in {s.state_id for s in self.states}
+        assert self.residual_state in {s.state_id for s in self.states}
 
         if pop_data.user_data["sim_state"] == "setup":  # simulation start
             if self.configuration_age_start != self.configuration_age_end != 0:
@@ -176,7 +196,7 @@ class DiseaseModel(Machine):
             )
         else:
             condition_column = pd.Series(
-                self.initial_state, index=population.index, name=self.state_column
+                self.residual_state, index=population.index, name=self.state_column
             )
         self.population_view.update(condition_column)
 
@@ -197,7 +217,7 @@ class DiseaseModel(Machine):
     # Helper functions #
     ####################
 
-    def _get_default_initial_state(self):
+    def _get_default_residual_state(self):
         susceptible_states = [s for s in self.states if isinstance(s, SusceptibleState)]
         if len(susceptible_states) != 1:
             raise DiseaseModelError("Disease model must have exactly one SusceptibleState.")
@@ -219,7 +239,7 @@ class DiseaseModel(Machine):
         weights = np.array(weights).T
         weights_bins = np.cumsum(weights, axis=1)
 
-        state_names = [s.state_id for s in states] + [self.initial_state]
+        state_names = [s.state_id for s in states] + [self.residual_state]
 
         return state_names, weights_bins
 

vivarium_public_health/disease/special_disease.py

@@ -14,7 +14,6 @@ from typing import Any, Dict, List, Optional
 
 import pandas as pd
 from vivarium import Component
-from vivarium.framework.engine import Builder
 from vivarium.framework.event import Event
 from vivarium.framework.population import SimulantData
 from vivarium.framework.values import list_combiner, union_post_processor
@@ -101,8 +100,8 @@ class RiskAttributableDisease(Component):
             self.name: {
                 "data_sources": {
                     "raw_disability_weight": f"{self.cause}.disability_weight",
-                    "cause_specific_mortality_rate": "self::load_cause_specific_mortality_rate_data",
-                    "excess_mortality_rate": "self::load_excess_mortality_rate_data",
+                    "cause_specific_mortality_rate": self.load_cause_specific_mortality_rate_data,
+                    "excess_mortality_rate": self.load_excess_mortality_rate_data,
                     "population_attributable_fraction": 0,
                 },
                 "threshold": None,

vivarium_public_health/disease/state.py

@@ -282,11 +282,11 @@ class DiseaseState(BaseDiseaseState):
         return {
             f"{self.name}": {
                 "data_sources": {
-                    "prevalence": "self::load_prevalence",
-                    "birth_prevalence": "self::load_birth_prevalence",
-                    "dwell_time": "self::load_dwell_time",
-                    "disability_weight": "self::load_disability_weight",
-                    "excess_mortality_rate": "self::load_excess_mortality_rate",
+                    "prevalence": self.load_prevalence,
+                    "birth_prevalence": self.load_birth_prevalence,
+                    "dwell_time": self.load_dwell_time,
+                    "disability_weight": self.load_disability_weight,
+                    "excess_mortality_rate": self.load_excess_mortality_rate,
                 },
             },
         }

vivarium_public_health/disease/transition.py

@@ -43,7 +43,7 @@ class RateTransition(Transition):
         return {
             f"{self.name}": {
                 "data_sources": {
-                    "transition_rate": "self::load_transition_rate",
+                    "transition_rate": self.load_transition_rate,
                 },
             },
         }
@@ -156,7 +156,7 @@ class ProportionTransition(Transition):
         return {
             f"{self.name}": {
                 "data_sources": {
-                    "proportion": "self::load_proportion",
+                    "proportion": self.load_proportion,
                 },
             },
         }

vivarium_public_health/plugins/parser.py

@@ -9,7 +9,7 @@ that can parse configurations of components specific to the Vivarium Public
 Health package.
 
 """
-
+import warnings
 from importlib import import_module
 from typing import Any, Callable, Dict, List, Optional, Union
 
@@ -56,11 +56,13 @@ class CausesConfigurationParser(ComponentConfigurationParser):
     DEFAULT_MODEL_CONFIG = {
         "model_type": f"{DiseaseModel.__module__}.{DiseaseModel.__name__}",
         "initial_state": None,
+        "residual_state": None,
     }
     """Default cause model configuration if it's not explicitly specified.
     
-    If the initial state is not specified, the cause  model must have a state 
-    named 'susceptible'.
+    Initial state and residual state cannot both be provided. If neither initial
+    state nor residual state has been specified, the cause  model must have a
+    state named 'susceptible'.
     """
 
     DEFAULT_STATE_CONFIG = {
@@ -104,7 +106,7 @@ class CausesConfigurationParser(ComponentConfigurationParser):
             causes:
                 cause_1:
                     model_type: vivarium_public_health.disease.DiseaseModel
-                    initial_state: susceptible
+                    residual_state: susceptible
                     states:
                         susceptible:
                             cause_type: cause
@@ -247,11 +249,13 @@ class CausesConfigurationParser(ComponentConfigurationParser):
                 )
 
             model_type = import_by_path(cause_config.model_type)
-            initial_state = states.get(cause_config.initial_state, None)
+            residual_state = states.get(
+                cause_config.residual_state, states.get(cause_config.initial_state, None)
+            )
             model = model_type(
                 cause_name,
-                initial_state=initial_state,
                 states=list(states.values()),
+                residual_state=residual_state,
                 get_data_functions=data_sources,
             )
             cause_models.append(model)
@@ -403,7 +407,14 @@ class CausesConfigurationParser(ComponentConfigurationParser):
     # Validation methods #
     ######################
 
-    _CAUSE_KEYS = {"model_type", "initial_state", "states", "transitions", "data_sources"}
+    _CAUSE_KEYS = {
+        "model_type",
+        "initial_state",
+        "states",
+        "transitions",
+        "data_sources",
+        "residual_state",
+    }
     _STATE_KEYS = {
         "state_type",
         "cause_type",
@@ -535,11 +546,28 @@ class CausesConfigurationParser(ComponentConfigurationParser):
             )
         else:
             initial_state = cause_config.get("initial_state", None)
-            if initial_state is not None and initial_state not in states_config:
+            residual_state = cause_config.get("residual_state", None)
+            if initial_state is not None:
+                warnings.warn(
+                    "In the future, the 'initial_state' cause configuration will"
+                    " be used to initialize all simulants into that state. To"
+                    " retain the current behavior of defining a residual state,"
+                    " use the 'residual_state' cause configuration.",
+                    DeprecationWarning,
+                    stacklevel=2,
+                )
+                if residual_state is None:
+                    residual_state = initial_state
+                else:
+                    error_messages.append(
+                        "A cause may not have both 'initial_state and"
+                        " 'residual_state' configurations."
+                    )
+
+            if residual_state is not None and residual_state not in states_config:
                 error_messages.append(
-                    f"Initial state '{cause_config['initial_state']}' for cause "
-                    f"'{cause_name}' must be present in the states for cause "
-                    f"'{cause_name}."
+                    f"Residual state '{residual_state}' for cause '{cause_name}'"
+                    f" must be present in the states for cause '{cause_name}."
                 )
             for state_name, state_config in states_config.items():
                 error_messages += self._validate_state(cause_name, state_name, state_config)

vivarium_public_health/population/mortality.py

@@ -105,7 +105,7 @@ class Mortality(Component):
             "mortality": {
                 "data_sources": {
                     "all_cause_mortality_rate": "cause.all_causes.cause_specific_mortality_rate",
-                    "unmodeled_cause_specific_mortality_rate": "self::load_unmodeled_csmr",
+                    "unmodeled_cause_specific_mortality_rate": self.load_unmodeled_csmr,
                     "life_expectancy": "population.theoretical_minimum_risk_life_expectancy",
                 },
                 "unmodeled_causes": [],

{vivarium_public_health-3.1.0.dist-info → vivarium_public_health-3.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vivarium_public_health
-Version: 3.1.0
+Version: 3.1.1
 Summary: Components for modelling diseases, risks, and interventions with ``vivarium``
 Home-page: https://github.com/ihmeuw/vivarium_public_health
 Author: The vivarium developers
@@ -26,7 +26,7 @@ Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries
 License-File: LICENSE.txt
-Requires-Dist: vivarium >=3.0.3
+Requires-Dist: vivarium >=3.2.0
 Requires-Dist: layered-config-tree >=1.0.1
 Requires-Dist: loguru
 Requires-Dist: numpy <2.0.0

{vivarium_public_health-3.1.0.dist-info → vivarium_public_health-3.1.1.dist-info}/RECORD

@@ -1,13 +1,13 @@
 vivarium_public_health/__about__.py,sha256=RgWycPypKZS80TpSX7o41cREnG8PfguNHDHLuLyl820,487
 vivarium_public_health/__init__.py,sha256=GDeeP-7OlCBwPuv_xQoB1wNmvCaFsqfTB7qnnYApm0w,1343
-vivarium_public_health/_version.py,sha256=YVoF76lT0p3dIsqphNnDWuqSia3gZP1S1eQYXZ9FbSE,22
+vivarium_public_health/_version.py,sha256=14eImCCNxRh4pWMIfkKe4h5OCS1ICfRjHSj2AfgEXa0,22
 vivarium_public_health/utilities.py,sha256=5cl9jjVkOQ1UeXT4DjDMAhaBNNjAsDo-SVJwpv6FDw0,3071
 vivarium_public_health/disease/__init__.py,sha256=VUJHDLlE6ngo2qHNQUtZ8OWH5H_T7_ao-xsYKDkRmHw,443
-vivarium_public_health/disease/model.py,sha256=0WIYDEx-hwlUJp6Zl8m8bUMoWxuVkOWsJvh_YlZiOPs,8234
+vivarium_public_health/disease/model.py,sha256=wbQvRQF6faTjx6OzokLt6u_9vdAvUrx_P8iQmiKNfv4,9128
 vivarium_public_health/disease/models.py,sha256=01UK7yB2zGPFzmlIpvhd-XnGe6vSCMDza3QTidgY7Nc,3479
-vivarium_public_health/disease/special_disease.py,sha256=3vS1WsO__IwOK0Oe_CUmh3aaKrXIf2CANtmiqlS3pjc,14614
-vivarium_public_health/disease/state.py,sha256=PUSDE1UlvoCPT6jPEyCTQO1bXjjYxqzdIa6-Bxpd-7I,22370
-vivarium_public_health/disease/transition.py,sha256=fgeVMy86GLrNpZ3J9E4AC0iA5z3aVdP0ZQ0AWa_odTY,6452
+vivarium_public_health/disease/special_disease.py,sha256=ZBtS-eDVptbZ1OjD35dhJvkKw78oDUfTyQSLY7g74dw,14562
+vivarium_public_health/disease/state.py,sha256=ON1RGVLV2BAmq2aGR7u94j3Q0btb0Hz3flr1FCEQHtQ,22355
+vivarium_public_health/disease/transition.py,sha256=G2-L0JvX4tWaHN5zrYXMR2jFj_JXFe9LEbrWjIbplCc,6446
 vivarium_public_health/mslt/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vivarium_public_health/mslt/delay.py,sha256=aOYjMpMSHEVlJs0FuC2gdq3uj6_vKmkhDjoBtC4i9G0,22812
 vivarium_public_health/mslt/disease.py,sha256=TBqa7yj6k1oUbgkAe0rIgLpbdMLMFs4DiZ1Igi2BQBg,16663
@@ -16,12 +16,12 @@ vivarium_public_health/mslt/magic_wand_components.py,sha256=pnl-7MwIJIus6UjtvVmM
 vivarium_public_health/mslt/observer.py,sha256=O4rysQzAGE5oDkdXb0E-qjD9TPFphQHTn7_3Qj7pBL0,15225
 vivarium_public_health/mslt/population.py,sha256=v_p5VkjndAVJMuXaJQc3lAdzUWHlWCEQWH4A-c4phPA,7255
 vivarium_public_health/plugins/__init__.py,sha256=oBW_zfgG_LbwfgTDjUe0btfy9FaDvAbtXho1zQFnz0Y,76
-vivarium_public_health/plugins/parser.py,sha256=v78mj8awpdrB-oqK8udPI_7MZBChoKJOQN_e17fNEj8,31841
+vivarium_public_health/plugins/parser.py,sha256=WuhgV47EVUAMSR8pQxQfNfQWkR3QtAOL0zhqvLNGdBQ,32946
 vivarium_public_health/population/__init__.py,sha256=x_9rB93q64Krw-kbBDI1-_U_JsPO1_QrL03AwiFlwXI,243
 vivarium_public_health/population/add_new_birth_cohorts.py,sha256=k65Li0LYWl-JFHBUvLjJxkRv12EJw_FVxrOYgbd44q8,9078
 vivarium_public_health/population/base_population.py,sha256=jJMVWv_EO0ckUZHhh01dRbsRgL491Eg3thRxPwNiAeg,18866
 vivarium_public_health/population/data_transformations.py,sha256=YmqyrlrIBtHGp1nFyhesqlNryvB7Vr33eVu4fU4HWsA,22260
-vivarium_public_health/population/mortality.py,sha256=w7b_TUssHjRcnULdXu7MXKfZBjCrlYWbB94oO3JWogI,10264
+vivarium_public_health/population/mortality.py,sha256=WAHtqXOgkX7li_lLvfwJsvJvVjlS5RLvm0DVpu0K3n0,10261
 vivarium_public_health/results/__init__.py,sha256=rKUZGlRXJgEyFY4a_WJeg3XnC0l34S5guYZ0N9JJS4E,319
 vivarium_public_health/results/columns.py,sha256=V-L3JgTcsk51Zx9PcUwSgaE1iZjuGyfZ8aShPjynadU,495
 vivarium_public_health/results/disability.py,sha256=JQm3Q7CoGCT2AgxaoH6MKkvnq4xF83wfFmEvEOvTmvA,9876
@@ -42,8 +42,8 @@ vivarium_public_health/treatment/__init__.py,sha256=wONElu9aJbBYwpYIovYPYaN_GYfV
 vivarium_public_health/treatment/magic_wand.py,sha256=i9N57-MEuQv5B6dQ5iVMTAdOPghYcgiRRz-dTzigf1s,1980
 vivarium_public_health/treatment/scale_up.py,sha256=9Cl3_MaCNPtUPPKXf3hWYepIwMCFlFY24jt2jeyFQO4,7006
 vivarium_public_health/treatment/therapeutic_inertia.py,sha256=8Z97s7GfcpfLu1U1ESJSqeEk4L__a3M0GbBV21MFg2s,2346
-vivarium_public_health-3.1.0.dist-info/LICENSE.txt,sha256=mN4bNLUQNcN9njYRc_3jCZkfPySVpmM6MRps104FxA4,1548
-vivarium_public_health-3.1.0.dist-info/METADATA,sha256=YGem2GjFv7jkEz7_3VkJMsJjMtHolbwiFgBgL0LF4Mk,4061
-vivarium_public_health-3.1.0.dist-info/WHEEL,sha256=a7TGlA-5DaHMRrarXjVbQagU3Man_dCnGIWMJr5kRWo,91
-vivarium_public_health-3.1.0.dist-info/top_level.txt,sha256=VVInlpzCFD0UNNhjOq_j-a29odzjwUwYFTGfvqbi4dY,23
-vivarium_public_health-3.1.0.dist-info/RECORD,,
+vivarium_public_health-3.1.1.dist-info/LICENSE.txt,sha256=mN4bNLUQNcN9njYRc_3jCZkfPySVpmM6MRps104FxA4,1548
+vivarium_public_health-3.1.1.dist-info/METADATA,sha256=T9qvhChXoRbfWilAVz8Rbi2GkPMnDxsy-bcY16jZggk,4061
+vivarium_public_health-3.1.1.dist-info/WHEEL,sha256=a7TGlA-5DaHMRrarXjVbQagU3Man_dCnGIWMJr5kRWo,91
+vivarium_public_health-3.1.1.dist-info/top_level.txt,sha256=VVInlpzCFD0UNNhjOq_j-a29odzjwUwYFTGfvqbi4dY,23
+vivarium_public_health-3.1.1.dist-info/RECORD,,