Document ModelInfo.get_seeding_data

HopkinsIDD · Dec 10, 2024 · 692865f · 692865f
1 parent e31cac8
commit 692865f
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/flepimop/gempyor_pkg/src/gempyor/model_info.py b/flepimop/gempyor_pkg/src/gempyor/model_info.py
@@ -355,6 +355,18 @@ def write_simID(
         return fname
 
     def get_seeding_data(self, sim_id: int) -> tuple[nb.typed.Dict, npt.NDArray[np.number]]:
+        """
+        Pull the seeding data for the info represented by this model info instance.
+
+        Args:
+            sim_id: The simulation ID to pull seeding data for.
+
+        Returns:
+            A tuple containing the seeding data dictionary and the seeding data array.
+
+        See Also:
+            `gempyor.seeding.Seeding.get_from_config`
+        """
         return self.seeding.get_from_config(
             self.compartments,
             self.subpop_struct,