phylogenie 1.0.5__py3-none-any.whl → 1.0.6__py3-none-any.whl

phylogenie/backend/treesimulator.py

@@ -17,15 +17,16 @@ from phylogenie.skyline import (
 DEFAULT_POPULATION = "X"
 INFECTIOUS_POPULATION = "I"
 EXPOSED_POPULATION = "E"
+SUPERSPREADER_POPULATION = "S"
 
 
 @dataclass
 class TreeParams:
-    populations: str | list[str] = DEFAULT_POPULATION
+    populations: str | list[str]
+    transmission_rates: SkylineMatrixCoercible
+    removal_rates: SkylineVectorCoercible
+    sampling_proportions: SkylineVectorCoercible
     transition_rates: SkylineMatrixCoercible = 0
-    transmission_rates: SkylineMatrixCoercible = 0
-    removal_rates: SkylineVectorCoercible = 0
-    sampling_proportions: SkylineVectorCoercible = 0
 
 
 def generate_tree(
@@ -137,3 +138,25 @@ def get_BDEI_params(
         removal_rates=removal_rates,
         sampling_proportions=sampling_proportions,
     )
+
+
+def get_BDSS_params(
+    reproduction_number: SkylineParameterLike,
+    infectious_period: SkylineParameterLike,
+    superspreading_ratio: SkylineParameterLike,
+    superspreaders_proportion: SkylineParameterLike,
+    sampling_proportion: SkylineParameterLike,
+) -> TreeParams:
+    gamma = 1 / infectious_period
+    f_SS = superspreaders_proportion
+    r_SS = superspreading_ratio
+    lambda_IS = reproduction_number * gamma * f_SS / (1 + r_SS * f_SS - f_SS)
+    lambda_SI = (reproduction_number * gamma - r_SS * lambda_IS) * r_SS
+    lambda_SS = r_SS * lambda_IS
+    lambda_II = lambda_SI / r_SS
+    return TreeParams(
+        populations=[INFECTIOUS_POPULATION, SUPERSPREADER_POPULATION],
+        transmission_rates=[[lambda_II, lambda_IS], [lambda_SI, lambda_SS]],
+        removal_rates=gamma,
+        sampling_proportions=sampling_proportion,
+    )

phylogenie/core/trees/treesimulator.py

@@ -13,6 +13,7 @@ from phylogenie.backend.treesimulator import (
     generate_tree,
     get_BD_params,
     get_BDEI_params,
+    get_BDSS_params,
 )
 from phylogenie.core.factories import (
     int_factory,
@@ -28,6 +29,7 @@ class ParameterizationType(str, Enum):
     MTBD = "MTBD"
     BD = "BD"
     BDEI = "BDEI"
+    BDSS = "BDSS"
 
 
 class TreeSimulatorGenerator(TreesGenerator):
@@ -73,10 +75,10 @@ class TreeSimulatorGenerator(TreesGenerator):
 class MTBDTreeSimulatorGenerator(TreeSimulatorGenerator):
     parameterization: Literal[ParameterizationType.MTBD] = ParameterizationType.MTBD
     populations: str | list[str] = DEFAULT_POPULATION
+    transmission_rates: cfg.SkylineMatrixCoercibleConfig
+    removal_rates: cfg.SkylineVectorCoercibleConfig
     transition_rates: cfg.SkylineMatrixCoercibleConfig = 0
-    transmission_rates: cfg.SkylineMatrixCoercibleConfig = 0
-    removal_rates: cfg.SkylineVectorCoercibleConfig = 0
-    sampling_proportions: cfg.SkylineVectorCoercibleConfig = 0
+    sampling_proportions: cfg.SkylineVectorCoercibleConfig = 1
 
     def _generate_one(self, filename: str, rng: Generator, data: pgt.Data) -> None:
         self._generate_one_from_params(
@@ -103,9 +105,9 @@ class MTBDTreeSimulatorGenerator(TreeSimulatorGenerator):
 
 class BDTreeSimulatorGenerator(TreeSimulatorGenerator):
     parameterization: Literal[ParameterizationType.BD] = ParameterizationType.BD
-    reproduction_number: cfg.SkylineParameterLikeConfig = 0
-    infectious_period: cfg.SkylineParameterLikeConfig = 0
-    sampling_proportion: cfg.SkylineParameterLikeConfig = 0
+    reproduction_number: cfg.SkylineParameterLikeConfig
+    infectious_period: cfg.SkylineParameterLikeConfig
+    sampling_proportion: cfg.SkylineParameterLikeConfig = 1
 
     def _generate_one(self, filename: str, rng: Generator, data: pgt.Data) -> None:
         self._generate_one_from_params(
@@ -128,10 +130,10 @@ class BDTreeSimulatorGenerator(TreeSimulatorGenerator):
 
 class BDEITreeSimulatorGenerator(TreeSimulatorGenerator):
     parameterization: Literal[ParameterizationType.BDEI] = ParameterizationType.BDEI
-    reproduction_number: cfg.SkylineParameterLikeConfig = 0
-    infectious_period: cfg.SkylineParameterLikeConfig = 0
-    incubation_period: cfg.SkylineParameterLikeConfig = 0
-    sampling_proportion: cfg.SkylineParameterLikeConfig = 0
+    reproduction_number: cfg.SkylineParameterLikeConfig
+    infectious_period: cfg.SkylineParameterLikeConfig
+    incubation_period: cfg.SkylineParameterLikeConfig
+    sampling_proportion: cfg.SkylineParameterLikeConfig = 1
 
     def _generate_one(self, filename: str, rng: Generator, data: pgt.Data) -> None:
         self._generate_one_from_params(
@@ -155,7 +157,43 @@ class BDEITreeSimulatorGenerator(TreeSimulatorGenerator):
         )
 
 
+class BDSSTreeSimulatorGenerator(TreeSimulatorGenerator):
+    parameterization: Literal[ParameterizationType.BDSS] = ParameterizationType.BDSS
+    reproduction_number: cfg.SkylineParameterLikeConfig
+    infectious_period: cfg.SkylineParameterLikeConfig
+    superspreading_ratio: cfg.SkylineParameterLikeConfig
+    superspreaders_proportion: cfg.SkylineParameterLikeConfig
+    sampling_proportion: cfg.SkylineParameterLikeConfig = 1
+
+    def _generate_one(self, filename: str, rng: Generator, data: pgt.Data) -> None:
+        self._generate_one_from_params(
+            filename,
+            rng,
+            data,
+            get_BDSS_params(
+                reproduction_number=skyline_parameter_like_factory(
+                    self.reproduction_number, data
+                ),
+                infectious_period=skyline_parameter_like_factory(
+                    self.infectious_period, data
+                ),
+                superspreading_ratio=skyline_parameter_like_factory(
+                    self.superspreading_ratio, data
+                ),
+                superspreaders_proportion=skyline_parameter_like_factory(
+                    self.superspreaders_proportion, data
+                ),
+                sampling_proportion=skyline_parameter_like_factory(
+                    self.sampling_proportion, data
+                ),
+            ),
+        )
+
+
 TreeSimulatorGeneratorConfig = Annotated[
-    MTBDTreeSimulatorGenerator | BDTreeSimulatorGenerator | BDEITreeSimulatorGenerator,
+    MTBDTreeSimulatorGenerator
+    | BDTreeSimulatorGenerator
+    | BDEITreeSimulatorGenerator
+    | BDSSTreeSimulatorGenerator,
     Field(discriminator="parameterization"),
 ]

phylogenie/typings.py

@@ -21,4 +21,3 @@ Vector2D = list[Vector1D]
 Vector3D = list[Vector2D]
 
 Data = dict[str, str | Scalar | Vector1D | Vector2D | Vector3D]
-Size = int | tuple[int, int] | tuple[int, int, int]

{phylogenie-1.0.5.dist-info → phylogenie-1.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: phylogenie
-Version: 1.0.5
+Version: 1.0.6
 Summary: Generate phylogenetic datasets with minimal setup effort
 Author: Gabriele Marino
 Author-email: gabmarino.8601@gmail.com
@@ -46,7 +46,7 @@ Phylogenie comes packed with useful features, including:
   Simply specify the number of cores to use, and Phylogenie handles multiprocessing automatically.
 
 - **Pre-implemented parameterizations** 🎯  
-  Include canonical, fossilized birth-death, epidemiological, birth-death with exposed-infectious (BDEI), contact-tracing (CT), and more.
+  Include canonical, fossilized birth-death, epidemiological, birth-death with exposed-infectious (BDEI), birth-death with superspreading (BDSS), contact-tracing (CT), and more.
 
 - **Skyline parameter support** 🪜  
   Support for piece-wise constant parameters.

{phylogenie-1.0.5.dist-info → phylogenie-1.0.6.dist-info}/RECORD

@@ -3,7 +3,7 @@ phylogenie/backend/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 phylogenie/backend/remaster/__init__.py,sha256=g1oMKi6SX60Geq_e2AjBlf7-pDvLfrsT3gW6AORdbMo,509
 phylogenie/backend/remaster/generate.py,sha256=Sb5izUQO0GmUcIEMoXtHWLsh9c4vIeyNIUm7u4RVLdw,6100
 phylogenie/backend/remaster/reactions.py,sha256=oc2ZY9WtTajbOWjARDmA0JnS255tbVeMt1DmyCUp95M,5904
-phylogenie/backend/treesimulator.py,sha256=wvN7WZwUKGPWt7AetumQz1ZrUc4k_D6lftSaYG1hNBg,4587
+phylogenie/backend/treesimulator.py,sha256=6yoOnVXcNatw3jBfuTgOrJ56out9-dNRlcTH83iiqZ0,5440
 phylogenie/configs.py,sha256=HtRUWZ-zNq1--zTBWL3QFXX27Ybw5x1qSWcmx7Sz8YA,125
 phylogenie/core/__init__.py,sha256=pvQMohKFAPaSvujw7H5sQJn7SOSqENQUHECuVfUBVNg,402
 phylogenie/core/configs.py,sha256=9tUYWrmdDn_Gg6xnywCDcGDEk0gne0vYqFH9dXixJbM,1042
@@ -22,7 +22,7 @@ phylogenie/core/trees/remaster/__init__.py,sha256=FfgXYjkeosb22Anbp78re2NssWtNcN
 phylogenie/core/trees/remaster/configs.py,sha256=d4EqowYMb5I2TfBTgNf9H_X1t8aNCYJbh1RQmFoDxs4,362
 phylogenie/core/trees/remaster/factories.py,sha256=qla4pg4OgfE5lwQZuP3bEaMt7xIF4P6fQ1Z0IPpFxUs,812
 phylogenie/core/trees/remaster/generator.py,sha256=LZTnNHZej6E1QakTBaBwRQQRaeb6rfG61U61bGbgE5Y,7260
-phylogenie/core/trees/treesimulator.py,sha256=cr5Xod_OR6QQ-Lej86aXDYn_6J-tBIusXlqUTiKGSN4,5897
+phylogenie/core/trees/treesimulator.py,sha256=RpyRvXAHLHEOU9Ub9Yg61au7xP_rnbC7N0va43gbbx8,7319
 phylogenie/core/typeguards.py,sha256=wEBYJZZ_Q_bY7ZJSh00AXJeyc1X8ZoysoOiLwo24N1w,990
 phylogenie/main.py,sha256=n_joau3dWJIq0ZMHe4a_1_2GigTFagkfzUFuQEMlyRI,1158
 phylogenie/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -31,9 +31,9 @@ phylogenie/skyline/matrix.py,sha256=T2g_MtfrqXVVGug40Nka1Q0YrpIi4KKx72Z573J-V18,
 phylogenie/skyline/parameter.py,sha256=CJ5OEyRQG2Tg1WJWQ1IpfX-6hjJv80Zj8lMoRke5nnQ,4648
 phylogenie/skyline/vector.py,sha256=Zh6HWoziXQFKDz-XvVE2e_Tw1706NrbwcvBpyPpw_cc,7120
 phylogenie/typeguards.py,sha256=WBOSJSaOC8VDtrYoA2w_AYEXTpyKdCfmsM29KaKXl3A,1350
-phylogenie/typings.py,sha256=cW0WEQEKmjuz_KcRsOfE7aQH5QLM1i55R-2DDWJG8xM,617
-phylogenie-1.0.5.dist-info/LICENSE.txt,sha256=NUrDqElK-eD3I0WqC004CJsy6cs0JgsAoebDv_42-pw,1071
-phylogenie-1.0.5.dist-info/METADATA,sha256=0gil5OBrrH5SUNvF5zyogVe3mZh3KdT5K84Tc1YHi78,6251
-phylogenie-1.0.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-phylogenie-1.0.5.dist-info/entry_points.txt,sha256=Rt6_usN0FkBX1ZfiqCirjMN9FKOgFLG8rydcQ8kugeE,51
-phylogenie-1.0.5.dist-info/RECORD,,
+phylogenie/typings.py,sha256=93VRedBxrpzXkT4uaNu_1JiMzsOjp7fUy4kLv_eYxUE,565
+phylogenie-1.0.6.dist-info/LICENSE.txt,sha256=NUrDqElK-eD3I0WqC004CJsy6cs0JgsAoebDv_42-pw,1071
+phylogenie-1.0.6.dist-info/METADATA,sha256=zJP0tUUe17qjUcUVSeM8y3-7ng9e9R54W_phEVIGpgE,6291
+phylogenie-1.0.6.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+phylogenie-1.0.6.dist-info/entry_points.txt,sha256=Rt6_usN0FkBX1ZfiqCirjMN9FKOgFLG8rydcQ8kugeE,51
+phylogenie-1.0.6.dist-info/RECORD,,