sl-shared-assets 3.0.0rc1__py3-none-any.whl → 3.0.0rc2__py3-none-any.whl

sl_shared_assets/data_classes/runtime_data.py

@@ -4,7 +4,7 @@ restore the data acquisition and runtime management system to the same state acr
 the same animal.
 """
 
-from dataclasses import dataclass
+from dataclasses import field, dataclass
 
 from ataraxis_data_structures import YamlConfig
 
@@ -88,7 +88,7 @@ class LickTrainingDescriptor(YamlConfig):
     """The weight of the animal, in grams, at the beginning of the session."""
     dispensed_water_volume_ml: float
     """Stores the total water volume, in milliliters, dispensed during runtime."""
-    minimum_reward_delay: int
+    minimum_reward_delay_s: int
     """Stores the minimum delay, in seconds, that can separate the delivery of two consecutive water rewards."""
     maximum_reward_delay_s: int
     """Stores the maximum delay, in seconds, that can separate the delivery of two consecutive water rewards."""
@@ -100,6 +100,11 @@ class LickTrainingDescriptor(YamlConfig):
     """Stores the maximum number of consecutive rewards that can be delivered without the animal consuming them. If 
     the animal receives this many rewards without licking (consuming) them, reward delivery is paused until the animal 
     consumes the rewards."""
+    system_state_codes: dict[str, int] = field(
+        default_factory=lambda: {"idle": 0, "rest": 1, "run": 2, "lick training": 3, "run training": 4}
+    )
+    """Maps integer state-codes used by the acquisition system to communicate its states to human-readable state 
+    names."""
     experimenter_notes: str = "Replace this with your notes."
     """This field is not set during runtime. It is expected that each experimenter replaces this field with their 
     notes made during runtime."""
@@ -150,6 +155,11 @@ class RunTrainingDescriptor(YamlConfig):
     """Stores the maximum time, in seconds, the animal can dip below the running speed threshold to still receive the 
     reward. This allows animals that 'run' by taking a series of large steps, briefly dipping below speed threshold at 
     the end of each step, to still get water rewards."""
+    system_state_codes: dict[str, int] = field(
+        default_factory=lambda: {"idle": 0, "rest": 1, "run": 2, "lick training": 3, "run training": 4}
+    )
+    """Maps integer state-codes used by the acquisition system to communicate its states to human-readable state 
+    names."""
     experimenter_notes: str = "Replace this with your notes."
     """This field is not set during runtime. It is expected that each experimenter will replace this field with their 
     notes made during runtime."""
@@ -175,6 +185,11 @@ class MesoscopeExperimentDescriptor(YamlConfig):
     """Stores the maximum number of consecutive rewards that can be delivered without the animal consuming them. If 
     the animal receives this many rewards without licking (consuming) them, reward delivery is paused until the animal 
     consumes the rewards."""
+    system_state_codes: dict[str, int] = field(
+        default_factory=lambda: {"idle": 0, "rest": 1, "run": 2, "lick training": 3, "run training": 4}
+    )
+    """Maps integer state-codes used by the acquisition system to communicate its states to human-readable state 
+    names."""
     experimenter_notes: str = "Replace this with your notes."
     """This field is not set during runtime. It is expected that each experimenter will replace this field with their 
     notes made during runtime."""

sl_shared_assets/data_classes/runtime_data.pyi

@@ -1,5 +1,6 @@
-from dataclasses import dataclass
+from dataclasses import field, dataclass
 
+from _typeshed import Incomplete
 from ataraxis_data_structures import YamlConfig
 
 @dataclass()
@@ -50,11 +51,12 @@ class LickTrainingDescriptor(YamlConfig):
     experimenter: str
     mouse_weight_g: float
     dispensed_water_volume_ml: float
-    minimum_reward_delay: int
+    minimum_reward_delay_s: int
     maximum_reward_delay_s: int
     maximum_water_volume_ml: float
     maximum_training_time_m: int
     maximum_unconsumed_rewards: int = ...
+    system_state_codes: dict[str, int] = field(default_factory=Incomplete)
     experimenter_notes: str = ...
     experimenter_given_water_volume_ml: float = ...
     incomplete: bool = ...
@@ -77,6 +79,7 @@ class RunTrainingDescriptor(YamlConfig):
     maximum_training_time_m: int
     maximum_unconsumed_rewards: int = ...
     maximum_idle_time_s: float = ...
+    system_state_codes: dict[str, int] = field(default_factory=Incomplete)
     experimenter_notes: str = ...
     experimenter_given_water_volume_ml: float = ...
     incomplete: bool = ...
@@ -89,6 +92,7 @@ class MesoscopeExperimentDescriptor(YamlConfig):
     mouse_weight_g: float
     dispensed_water_volume_ml: float
     maximum_unconsumed_rewards: int = ...
+    system_state_codes: dict[str, int] = field(default_factory=Incomplete)
     experimenter_notes: str = ...
     experimenter_given_water_volume_ml: float = ...
     incomplete: bool = ...

{sl_shared_assets-3.0.0rc1.dist-info → sl_shared_assets-3.0.0rc2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sl-shared-assets
-Version: 3.0.0rc1
+Version: 3.0.0rc2
 Summary: Provides data acquisition and processing assets shared between Sun (NeuroAI) lab libraries.
 Project-URL: Homepage, https://github.com/Sun-Lab-NBB/sl-shared-assets
 Project-URL: Documentation, https://sl-shared-assets-api-docs.netlify.app/

{sl_shared_assets-3.0.0rc1.dist-info → sl_shared_assets-3.0.0rc2.dist-info}/RECORD

@@ -7,8 +7,8 @@ sl_shared_assets/data_classes/__init__.py,sha256=ixn972b-3URCinVLRPjMfDXpO2w24_N
 sl_shared_assets/data_classes/__init__.pyi,sha256=bDBLkyhlosB4t09GxHBNKH0kaVBhHSY_j-i3MD2iKVo,2088
 sl_shared_assets/data_classes/configuration_data.py,sha256=h6o7Uaz2HZjV-9-wc5iz5xfkhVpPWPrncU8VU7_AeB8,30587
 sl_shared_assets/data_classes/configuration_data.pyi,sha256=fb12sdDuYJtfEurzbg6WcCU0NIm1mudsgsGdUVFTajQ,10305
-sl_shared_assets/data_classes/runtime_data.py,sha256=TpqT2lRNq6fJyOgwXEqqI1gfTinEpCVTp8RKlvfqgkk,15789
-sl_shared_assets/data_classes/runtime_data.pyi,sha256=o_eLLHWoAp_w58C2YEIeSHCD36ZYsTsCllRUEIxusSo,6660
+sl_shared_assets/data_classes/runtime_data.py,sha256=V98VSUHBFiqRngHAYtH6r6X_zDht65wi9TpdbbYAhS8,16656
+sl_shared_assets/data_classes/runtime_data.pyi,sha256=zATWUIP0whD0iRpxkvt78cLL_Ajr-d_9C6goHdTLnSw,6927
 sl_shared_assets/data_classes/session_data.py,sha256=0dNv_49WJeUf5IYgbGMWnMwX3aAYPIv7u8OJM5itIJA,50673
 sl_shared_assets/data_classes/session_data.pyi,sha256=8EqaQbydl2fwDFBMDh77fbSd7os2t0x9GwDJYYsPtLY,16400
 sl_shared_assets/data_classes/surgery_data.py,sha256=qsMj3NkjhylAT9b_wHBY-1XwTu2xsZcZatdECmkA7Bs,7437
@@ -29,8 +29,8 @@ sl_shared_assets/tools/project_management_tools.py,sha256=Z_U0R26w9Le1O-u66gyF5C
 sl_shared_assets/tools/project_management_tools.pyi,sha256=4kok98nOZ4KnT-Sg-ZCZYg-WIM5qZqiyK8g1XiiDjHM,10375
 sl_shared_assets/tools/transfer_tools.py,sha256=J26kwOp_NpPSY0-xu5FTw9udte-rm_mW1FJyaTNoqQI,6606
 sl_shared_assets/tools/transfer_tools.pyi,sha256=FoH7eYZe7guGHfPr0MK5ggO62uXKwD2aJ7h1Bu7PaEE,3294
-sl_shared_assets-3.0.0rc1.dist-info/METADATA,sha256=HNDv3CbPB27Vv-hfHohnB2h1IzdHwDX4Qolq58uWwlw,49309
-sl_shared_assets-3.0.0rc1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sl_shared_assets-3.0.0rc1.dist-info/entry_points.txt,sha256=UmO1rl7ly9N7HWPwWyP9E0b5KBUStpBo4TRoqNtizDY,430
-sl_shared_assets-3.0.0rc1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-sl_shared_assets-3.0.0rc1.dist-info/RECORD,,
+sl_shared_assets-3.0.0rc2.dist-info/METADATA,sha256=mCoBnEMzF796sZr6H6yqwY0N-T46sSWNoJXg29x0FZ4,49309
+sl_shared_assets-3.0.0rc2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sl_shared_assets-3.0.0rc2.dist-info/entry_points.txt,sha256=UmO1rl7ly9N7HWPwWyP9E0b5KBUStpBo4TRoqNtizDY,430
+sl_shared_assets-3.0.0rc2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+sl_shared_assets-3.0.0rc2.dist-info/RECORD,,