vivarium-public-health 4.3.6__py3-none-any.whl → 4.3.8__py3-none-any.whl

vivarium_public_health/_version.py

@@ -1 +1 @@
-__version__ = "4.3.6"
+__version__ = "4.3.8"

vivarium_public_health/population/base_population.py

@@ -166,7 +166,7 @@ class BasePopulation(Component):
         demographic_proportions, year: int
     ) -> pd.DataFrame:
         reference_years = sorted(set(demographic_proportions.year_start))
-        ref_year_index = np.digitize(year, reference_years).item() - 1
+        ref_year_index = _find_bin_start_index(year, reference_years)
         return demographic_proportions[
             demographic_proportions.year_start == reference_years[ref_year_index]
         ]
@@ -257,22 +257,22 @@ class ScaledPopulation(BasePopulation):
         if "year_start" not in scaling_factor.index.names:
             return population_structure, scaling_factor
 
-        # Subset to start year of simulation or closest year
+        # Subset the population structure and scaling factors to the simulation
+        # start year. If the data does not contain the exact simulation start
+        # year, subset to the closest year less than the simulation start year.
         pop_reference_years = sorted(
             set(population_structure.index.get_level_values("year_start"))
         )
-        pop_year_index = np.digitize(year, pop_reference_years).item() - 1
-        scale_reference_years = sorted(
-            set(scaling_factor.index.get_level_values("year_start"))
-        )
-        scale_year_index = np.digitize(year, scale_reference_years).item() - 1
-        # Subset to start year of simulation or earliest year. E.g. if start year = 2021 and pop
-        # structure has 2021, we will subset to 2021. If pop structure minimum year is 2025, we
-        # will subset to 2025.
+        pop_year_index = _find_bin_start_index(year, pop_reference_years)
         population_structure = population_structure.loc[
             population_structure.index.get_level_values("year_start")
             == pop_reference_years[pop_year_index]
         ]
+
+        scale_reference_years = sorted(
+            set(scaling_factor.index.get_level_values("year_start"))
+        )
+        scale_year_index = _find_bin_start_index(year, scale_reference_years)
         scaling_factor = scaling_factor.loc[
             scaling_factor.index.get_level_values("year_start")
             == scale_reference_years[scale_year_index]
@@ -527,3 +527,31 @@ def _assign_demography_with_age_bounds(
     )
     register_simulants(simulants[list(key_columns)])
     return simulants
+
+
+def _find_bin_start_index(value: int, sorted_reference_values: list[int]) -> int:
+    """Finds the index of the closest reference value less than or equal to the provided value.
+
+    Parameters
+    ----------
+    value
+        The value for which to find the closest reference value.
+    sorted_reference_values
+        A sorted list of reference values.
+
+    Returns
+    -------
+        The index of the closest reference value less than or equal to the provided value.
+
+    Raises
+    ------
+        ValueError
+            If the provided value is less than the minimum reference value.
+    """
+    ref_value_index = np.digitize(value, sorted_reference_values).item() - 1
+    if ref_value_index < 0:
+        raise ValueError(
+            f"The provided value {value} is less than the minimum reference value "
+            f"{min(sorted_reference_values)}."
+        )
+    return ref_value_index

{vivarium_public_health-4.3.6.dist-info → vivarium_public_health-4.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vivarium_public_health
-Version: 4.3.6
+Version: 4.3.8
 Summary: Components for modelling diseases, risks, and interventions with ``vivarium``
 Home-page: https://github.com/ihmeuw/vivarium_public_health
 Author: The vivarium developers
@@ -28,7 +28,7 @@ Classifier: Topic :: Software Development :: Libraries
 License-File: LICENSE.txt
 Requires-Dist: vivarium_dependencies[loguru,numpy_lt_2,pandas,pyarrow,scipy,tables]
 Requires-Dist: vivarium_build_utils<3.0.0,>=2.0.1
-Requires-Dist: vivarium>=3.4.3
+Requires-Dist: vivarium<4.0.0,>=3.4.3
 Requires-Dist: layered_config_tree
 Requires-Dist: risk_distributions>=2.0.11
 Provides-Extra: docs

{vivarium_public_health-4.3.6.dist-info → vivarium_public_health-4.3.8.dist-info}/RECORD

@@ -1,6 +1,6 @@
 vivarium_public_health/__about__.py,sha256=RgWycPypKZS80TpSX7o41cREnG8PfguNHDHLuLyl820,487
 vivarium_public_health/__init__.py,sha256=GDeeP-7OlCBwPuv_xQoB1wNmvCaFsqfTB7qnnYApm0w,1343
-vivarium_public_health/_version.py,sha256=bXuOm7EMaj1zGwMTlGgJNLOisp5gk6scG4bpGO0RNd8,22
+vivarium_public_health/_version.py,sha256=dLqyaaleWhnp4yrZn9zE22wdSuPXoW1FxtYtQhjJgqQ,22
 vivarium_public_health/utilities.py,sha256=QNXQ6fhAr1HcV-GwKw7wQLz6QyuNxqNvMA-XujKjTgs,3035
 vivarium_public_health/disease/__init__.py,sha256=VUJHDLlE6ngo2qHNQUtZ8OWH5H_T7_ao-xsYKDkRmHw,443
 vivarium_public_health/disease/exceptions.py,sha256=vb30IIV82OiDf2cNZCs_E2rF6mdDDHbnZSND60no5CU,97
@@ -20,7 +20,7 @@ vivarium_public_health/plugins/__init__.py,sha256=oBW_zfgG_LbwfgTDjUe0btfy9FaDvA
 vivarium_public_health/plugins/parser.py,sha256=WoUisq0d-PfJtSzKYZ6C-s-fYdQpNiRBE14vKaYE27Y,32921
 vivarium_public_health/population/__init__.py,sha256=x_9rB93q64Krw-kbBDI1-_U_JsPO1_QrL03AwiFlwXI,243
 vivarium_public_health/population/add_new_birth_cohorts.py,sha256=x6A60GE_F3I8AgLABNJ-2ziiUj52lAd66uX5yc2vIDI,9038
-vivarium_public_health/population/base_population.py,sha256=XwfIfJRIcJsxphK62nVPZbrcAw0_7dhxGVuPEnGw3R0,20550
+vivarium_public_health/population/base_population.py,sha256=IqQFVZiw-bSDX1MHjwn6pmQYoJksKNwi0OQo_uHZyDM,21399
 vivarium_public_health/population/data_transformations.py,sha256=YHbwfb40EPbXsPW-Rk1s5d61rP8fqgDtMELB7OJG3mo,22662
 vivarium_public_health/population/mortality.py,sha256=Mtv45FENNY0GlPIoVd3d3pRq01aEh4cjzNXIgEe6hMo,10364
 vivarium_public_health/results/__init__.py,sha256=rKUZGlRXJgEyFY4a_WJeg3XnC0l34S5guYZ0N9JJS4E,319
@@ -43,8 +43,8 @@ vivarium_public_health/treatment/__init__.py,sha256=wONElu9aJbBYwpYIovYPYaN_GYfV
 vivarium_public_health/treatment/magic_wand.py,sha256=zg4I48G-l9fC6-qjvApbM1zNACJimZlX9ZZ9fdHKwvc,1985
 vivarium_public_health/treatment/scale_up.py,sha256=_bsf9c_yVc7-q_-yBcXimISTUfYzPps1auH0uEf7sfQ,7048
 vivarium_public_health/treatment/therapeutic_inertia.py,sha256=ZIHnpuszZwA_BkS53JbSLvpcnX_bqG2knwCUyUgkA9M,2362
-vivarium_public_health-4.3.6.dist-info/licenses/LICENSE.txt,sha256=mN4bNLUQNcN9njYRc_3jCZkfPySVpmM6MRps104FxA4,1548
-vivarium_public_health-4.3.6.dist-info/METADATA,sha256=YdB1JSLxInm6y2_uIOnjiG8tqavEJQiOBsQaxn9tqgA,3877
-vivarium_public_health-4.3.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-vivarium_public_health-4.3.6.dist-info/top_level.txt,sha256=VVInlpzCFD0UNNhjOq_j-a29odzjwUwYFTGfvqbi4dY,23
-vivarium_public_health-4.3.6.dist-info/RECORD,,
+vivarium_public_health-4.3.8.dist-info/licenses/LICENSE.txt,sha256=mN4bNLUQNcN9njYRc_3jCZkfPySVpmM6MRps104FxA4,1548
+vivarium_public_health-4.3.8.dist-info/METADATA,sha256=LXpE6AlH6nSHMwBWydYAkSVZzNO8zjQ9DXU-PiVk0ls,3884
+vivarium_public_health-4.3.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+vivarium_public_health-4.3.8.dist-info/top_level.txt,sha256=VVInlpzCFD0UNNhjOq_j-a29odzjwUwYFTGfvqbi4dY,23
+vivarium_public_health-4.3.8.dist-info/RECORD,,