sl-shared-assets 4.0.0__py3-none-any.whl → 4.0.1__py3-none-any.whl

sl_shared_assets/cli.py

@@ -21,6 +21,7 @@ from .data_classes import SessionData, TrackerFileNames, get_processing_tracker
 @click.option(
     "-id",
     "--manager_id",
+    type=int,
     required=True,
     default=0,
     show_default=True,

sl_shared_assets/data_classes/runtime_data.py

@@ -104,9 +104,6 @@ class LickTrainingDescriptor(YamlConfig):
     dispensed during the paused (idle) state."""
     pause_dispensed_water_volume_ml: float = 0.0
     """Stores the total water volume, in milliliters, dispensed during the paused (idle) state."""
-    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."""
     experimenter_given_water_volume_ml: float = 0.0
     """The additional volume of water, in milliliters, administered by the experimenter to the animal after the session.
     """
@@ -116,6 +113,9 @@ class LickTrainingDescriptor(YamlConfig):
     incomplete: bool = False
     """If this field is set to True, the session is marked as 'incomplete' and automatically excluded from all further 
     Sun lab automated processing and analysis."""
+    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."""
 
 
 @dataclass()
@@ -160,9 +160,6 @@ class RunTrainingDescriptor(YamlConfig):
     dispensed during the paused (idle) state."""
     pause_dispensed_water_volume_ml: float = 0.0
     """Stores the total water volume, in milliliters, dispensed during the paused (idle) state."""
-    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."""
     experimenter_given_water_volume_ml: float = 0.0
     """The additional volume of water, in milliliters, administered by the experimenter to the animal after the session.
     """
@@ -172,6 +169,9 @@ class RunTrainingDescriptor(YamlConfig):
     incomplete: bool = False
     """If this field is set to True, the session is marked as 'incomplete' and automatically excluded from all further 
     Sun lab automated processing and analysis."""
+    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."""
 
 
 @dataclass()
@@ -191,9 +191,6 @@ class MesoscopeExperimentDescriptor(YamlConfig):
     dispensed during the paused (idle) state."""
     pause_dispensed_water_volume_ml: float = 0.0
     """Stores the total water volume, in milliliters, dispensed during the paused (idle) state."""
-    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."""
     experimenter_given_water_volume_ml: float = 0.0
     """The additional volume of water, in milliliters, administered by the experimenter to the animal after the session.
     """
@@ -203,6 +200,9 @@ class MesoscopeExperimentDescriptor(YamlConfig):
     incomplete: bool = False
     """If this field is set to True, the session is marked as 'incomplete' and automatically excluded from all further 
     Sun lab automated processing and analysis."""
+    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."""
 
 
 @dataclass()
@@ -217,14 +217,14 @@ class WindowCheckingDescriptor(YamlConfig):
 
     experimenter: str
     """The ID of the experimenter running the session."""
-    experimenter_notes: str = "Replace this with your notes."
-    """The notes on the quality of the cranial window and animal's suitability for the target project."""
     surgery_quality: int = 0
     """The quality of the cranial window and surgical intervention on a scale from 0 (non-usable) to 
     3 (high-tier publication grade) inclusive."""
     incomplete: bool = True
     """Window checking sessions are always considered 'incomplete', as they do not contain the full range of 
     information collected as part of a 'standard' behavior training or experiment session."""
+    experimenter_notes: str = "Replace this with your notes."
+    """The notes on the quality of the cranial window and animal's suitability for the target project."""
 
 
 @dataclass()

sl_shared_assets/data_classes/runtime_data.pyi

@@ -56,10 +56,10 @@ class LickTrainingDescriptor(YamlConfig):
     maximum_unconsumed_rewards: int = ...
     dispensed_water_volume_ml: float = ...
     pause_dispensed_water_volume_ml: float = ...
-    experimenter_notes: str = ...
     experimenter_given_water_volume_ml: float = ...
     preferred_session_water_volume_ml: float = ...
     incomplete: bool = ...
+    experimenter_notes: str = ...
 
 @dataclass()
 class RunTrainingDescriptor(YamlConfig):
@@ -80,10 +80,10 @@ class RunTrainingDescriptor(YamlConfig):
     maximum_idle_time_s: float = ...
     dispensed_water_volume_ml: float = ...
     pause_dispensed_water_volume_ml: float = ...
-    experimenter_notes: str = ...
     experimenter_given_water_volume_ml: float = ...
     preferred_session_water_volume_ml: float = ...
     incomplete: bool = ...
+    experimenter_notes: str = ...
 
 @dataclass()
 class MesoscopeExperimentDescriptor(YamlConfig):
@@ -94,10 +94,10 @@ class MesoscopeExperimentDescriptor(YamlConfig):
     maximum_unconsumed_rewards: int = ...
     dispensed_water_volume_ml: float = ...
     pause_dispensed_water_volume_ml: float = ...
-    experimenter_notes: str = ...
     experimenter_given_water_volume_ml: float = ...
     preferred_session_water_volume_ml: float = ...
     incomplete: bool = ...
+    experimenter_notes: str = ...
 
 @dataclass()
 class WindowCheckingDescriptor(YamlConfig):
@@ -110,9 +110,9 @@ class WindowCheckingDescriptor(YamlConfig):
     """
 
     experimenter: str
-    experimenter_notes: str = ...
     surgery_quality: int = ...
     incomplete: bool = ...
+    experimenter_notes: str = ...
 
 @dataclass()
 class ZaberPositions(YamlConfig):

sl_shared_assets/data_classes/surgery_data.py

@@ -65,7 +65,7 @@ class ImplantData:
     """The descriptive name of the implant."""
     implant_target: str
     """The name of the brain region or cranium section targeted by the implant."""
-    implant_code: int
+    implant_code: str
     """The manufacturer code or internal reference code for the implant. This code is used to identify the implant in 
     additional datasheets and lab ordering documents."""
     implant_ap_coordinate_mm: float
@@ -89,7 +89,7 @@ class InjectionData:
     """The name of the brain region targeted by the injection."""
     injection_volume_nl: float
     """The volume of substance, in nanoliters, delivered during the injection."""
-    injection_code: int
+    injection_code: str
     """The manufacturer code or internal reference code for the injected substance. This code is used to identify the 
     substance in additional datasheets and lab ordering documents."""
     injection_ap_coordinate_mm: float
@@ -108,22 +108,22 @@ class DrugData:
 
     lactated_ringers_solution_volume_ml: float
     """Stores the volume of Lactated Ringer's Solution (LRS) administered during surgery, in ml."""
-    lactated_ringers_solution_code: int
+    lactated_ringers_solution_code: str
     """Stores the manufacturer code or internal reference code for Lactated Ringer's Solution (LRS). This code is used 
     to identify the LRS batch in additional datasheets and lab ordering documents."""
     ketoprofen_volume_ml: float
     """Stores the volume of ketoprofen diluted with saline administered during surgery, in ml."""
-    ketoprofen_code: int
+    ketoprofen_code: str
     """Stores the manufacturer code or internal reference code for ketoprofen. This code is used to identify the 
     ketoprofen batch in additional datasheets and lab ordering documents."""
     buprenorphine_volume_ml: float
     """Stores the volume of buprenorphine diluted with saline administered during surgery, in ml."""
-    buprenorphine_code: int
+    buprenorphine_code: str
     """Stores the manufacturer code or internal reference code for buprenorphine. This code is used to identify the 
     buprenorphine batch in additional datasheets and lab ordering documents."""
     dexamethasone_volume_ml: float
     """Stores the volume of dexamethasone diluted with saline administered during surgery, in ml."""
-    dexamethasone_code: int
+    dexamethasone_code: str
     """Stores the manufacturer code or internal reference code for dexamethasone. This code is used to identify the 
     dexamethasone batch in additional datasheets and lab ordering documents."""
 

sl_shared_assets/data_classes/surgery_data.pyi

@@ -37,7 +37,7 @@ class ImplantData:
 
     implant: str
     implant_target: str
-    implant_code: int
+    implant_code: str
     implant_ap_coordinate_mm: float
     implant_ml_coordinate_mm: float
     implant_dv_coordinate_mm: float
@@ -52,7 +52,7 @@ class InjectionData:
     injection: str
     injection_target: str
     injection_volume_nl: float
-    injection_code: int
+    injection_code: str
     injection_ap_coordinate_mm: float
     injection_ml_coordinate_mm: float
     injection_dv_coordinate_mm: float
@@ -64,13 +64,13 @@ class DrugData:
     """
 
     lactated_ringers_solution_volume_ml: float
-    lactated_ringers_solution_code: int
+    lactated_ringers_solution_code: str
     ketoprofen_volume_ml: float
-    ketoprofen_code: int
+    ketoprofen_code: str
     buprenorphine_volume_ml: float
-    buprenorphine_code: int
+    buprenorphine_code: str
     dexamethasone_volume_ml: float
-    dexamethasone_code: int
+    dexamethasone_code: str
 
 @dataclass
 class SurgeryData(YamlConfig):

{sl_shared_assets-4.0.0.dist-info → sl_shared_assets-4.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sl-shared-assets
-Version: 4.0.0
+Version: 4.0.1
 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/
@@ -713,16 +713,21 @@ Requires-Dist: ruff==0.12.7; extra == 'conda'
 Requires-Dist: sphinx-autodoc-typehints==3.2.0; extra == 'conda'
 Requires-Dist: sphinx-click==6.0.0; extra == 'conda'
 Requires-Dist: sphinx==8.2.3; extra == 'conda'
+Requires-Dist: tox-uv==1.26.2; extra == 'conda'
+Requires-Dist: tox==4.28.4; extra == 'conda'
 Requires-Dist: twine==6.1.0; extra == 'conda'
 Requires-Dist: types-appdirs==1.4.3.5; extra == 'conda'
 Requires-Dist: types-filelock==3.2.7; extra == 'conda'
 Requires-Dist: types-paramiko==3.5.0.20250801; extra == 'conda'
+Requires-Dist: types-pytz==2025.2.0.20250516; extra == 'conda'
 Requires-Dist: types-tqdm==4.67.0.20250516; extra == 'conda'
+Requires-Dist: uv==0.8.4; extra == 'conda'
 Provides-Extra: condarun
 Requires-Dist: appdirs==1.4.4; extra == 'condarun'
 Requires-Dist: filelock==3.18.0; extra == 'condarun'
 Requires-Dist: natsort==8.4.0; extra == 'condarun'
 Requires-Dist: numpy==2.2.6; extra == 'condarun'
+Requires-Dist: polars==1.32.0; extra == 'condarun'
 Requires-Dist: pyarrow==21.0.0; extra == 'condarun'
 Requires-Dist: pytz==2025.2; extra == 'condarun'
 Requires-Dist: tqdm==4.67.1; extra == 'condarun'
@@ -752,10 +757,6 @@ Requires-Dist: ataraxis-automation==5.0.0; extra == 'noconda'
 Requires-Dist: build==1.3.0; extra == 'noconda'
 Requires-Dist: sphinx-rtd-dark-mode==1.3.0; extra == 'noconda'
 Requires-Dist: sphinx-rtd-theme==3.0.2; extra == 'noconda'
-Requires-Dist: tox-uv==1.26.2; extra == 'noconda'
-Requires-Dist: tox==4.28.4; extra == 'noconda'
-Requires-Dist: types-pytz==2025.2.0.20250516; extra == 'noconda'
-Requires-Dist: uv==0.8.4; extra == 'noconda'
 Description-Content-Type: text/markdown
 
 # sl-shared-assets

{sl_shared_assets-4.0.0.dist-info → sl_shared_assets-4.0.1.dist-info}/RECORD

@@ -1,18 +1,18 @@
 sl_shared_assets/__init__.py,sha256=h4QBqUSvHTDYo9xJgfSzVwIRmH5RJEKgNPA0Hoy274Q,2611
 sl_shared_assets/__init__.pyi,sha256=rFWG-cUSrwlNyaxMX0LGR42WS4YE_Q5-PzPiYuum6V0,2996
-sl_shared_assets/cli.py,sha256=8c7OdJ5LSUMtSjzWqQ5i2JdO9hpOa7_b75dugqd0aQI,19828
+sl_shared_assets/cli.py,sha256=pUebcXDlG47CAQnCGFSNBEKdpzeD8_zDRwg74LDkc04,19842
 sl_shared_assets/cli.pyi,sha256=_jErcrfdWROiZJm4QnZGQC85bw5FWKvs0LIwm3bR6nI,5408
 sl_shared_assets/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sl_shared_assets/data_classes/__init__.py,sha256=BSWFbTavTAHZx1ss1EgNr16an9iUz5HDOq617HpVXNE,2143
 sl_shared_assets/data_classes/__init__.pyi,sha256=IgdbnAxhPGNmwjStwEZspvdBxm2aP67gX6eLlT_f8Ew,2463
 sl_shared_assets/data_classes/configuration_data.py,sha256=bmD9bICgRtsM2P1wSInUfjlmaT2ZjiOwPlo87EkYt8U,36361
 sl_shared_assets/data_classes/configuration_data.pyi,sha256=1_kmBDPGkHmVwXEGYR_3uERBSsenQOTuquMBtjKVTA8,11068
-sl_shared_assets/data_classes/runtime_data.py,sha256=BaGL-UX_Kgp-45sc8SoiQK-56Zjd-EwdtysFQ5TKYEw,17565
-sl_shared_assets/data_classes/runtime_data.pyi,sha256=SFZIN_rD2SzmOWW08_2Qp58rkn9_KRHyQlPjHyWVThY,6942
+sl_shared_assets/data_classes/runtime_data.py,sha256=ruo5KZ1VSfGwSg_gtSyWTbLBFcfG7Az455cKxiUpDoc,17565
+sl_shared_assets/data_classes/runtime_data.pyi,sha256=kCVSpS69goF-MRCZtp7EnoruTye64rjKsdPoDiC0PjU,6942
 sl_shared_assets/data_classes/session_data.py,sha256=MuzKQYILXJVCCNHzkLq9yrGAin4yj3bbiW4q8P0jmMk,51106
 sl_shared_assets/data_classes/session_data.pyi,sha256=KTQr0OXfeOk8eaUOsXW2-2UYjIjWcZSoW7Hv69l6JW0,20653
-sl_shared_assets/data_classes/surgery_data.py,sha256=eGrblvexcWLxAhF7Oy0UEihYqjRyXy0GfAdTkBFUlHw,7495
-sl_shared_assets/data_classes/surgery_data.pyi,sha256=KoTJZ5XQGXFiVCaI5NsGHAelLZhIPmxB7mPCl3GJeP0,2615
+sl_shared_assets/data_classes/surgery_data.py,sha256=riwyULMdZ8pDXFLdyNByNSeMk1-mVTo1FcCl5FrThas,7495
+sl_shared_assets/data_classes/surgery_data.pyi,sha256=3ILU5H_BUXEE9YXgPdVMC10jxivixPlJILBMg7OdEwc,2615
 sl_shared_assets/server/__init__.py,sha256=GOQ7wWjiS5Xg_WgTqeEqCTRF9ms9GXx0nffCr-BmKsA,453
 sl_shared_assets/server/__init__.pyi,sha256=Zc12G90fZdgEMwaVZbFzrRVV1wH_LEj3sxaV3lhk1Cw,316
 sl_shared_assets/server/job.py,sha256=wZbppMrv6fqch79bKLjOGQ9AYfjiDKDnTyUe7xgAT44,19461
@@ -29,8 +29,8 @@ sl_shared_assets/tools/project_management_tools.py,sha256=9A133D38BkvRX_tXGS5-o6
 sl_shared_assets/tools/project_management_tools.pyi,sha256=NwmqHwSC0uu8vxtHDA7BTv1dneibj7MErE4XHeGRQTI,13251
 sl_shared_assets/tools/transfer_tools.py,sha256=vqYO4sERZV0W1DFNFnTpJA6QBZ4QJA94a2TyUhZW2Qk,6605
 sl_shared_assets/tools/transfer_tools.pyi,sha256=WtUGfaKV9FP_CnhBg_UvclpuDvOlEESOSMlEDtWpOLg,3293
-sl_shared_assets-4.0.0.dist-info/METADATA,sha256=3QtSJ8Jn8tH6dPHswpWI-T_puE45dAzdl3zbMsnLkAA,56898
-sl_shared_assets-4.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sl_shared_assets-4.0.0.dist-info/entry_points.txt,sha256=UmO1rl7ly9N7HWPwWyP9E0b5KBUStpBo4TRoqNtizDY,430
-sl_shared_assets-4.0.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-sl_shared_assets-4.0.0.dist-info/RECORD,,
+sl_shared_assets-4.0.1.dist-info/METADATA,sha256=KzF2ukjsxK_Sef1sUbSBLeR_7mzvLaPkN9zr4kgheRw,56941
+sl_shared_assets-4.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sl_shared_assets-4.0.1.dist-info/entry_points.txt,sha256=UmO1rl7ly9N7HWPwWyP9E0b5KBUStpBo4TRoqNtizDY,430
+sl_shared_assets-4.0.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+sl_shared_assets-4.0.1.dist-info/RECORD,,