sl-shared-assets 1.0.0rc3__tar.gz → 1.0.0rc5__tar.gz

{sl_shared_assets-1.0.0rc3 → sl_shared_assets-1.0.0rc5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sl-shared-assets
-Version: 1.0.0rc3
+Version: 1.0.0rc5
 Summary: Stores assets shared between multiple Sun (NeuroAI) lab data pipelines.
 Project-URL: Homepage, https://github.com/Sun-Lab-NBB/sl-shared-assets
 Project-URL: Documentation, https://sl-shared-assets-api-docs.netlify.app/
@@ -805,7 +805,7 @@ Note, installation from source is ***highly discouraged*** for everyone who is n
    wheel into the active python environment.
 
 ### pip
-Use the following command to install the library using pip: ```pip install sl-experiment```.
+Use the following command to install the library using pip: ```pip install sl-shared-assets```.
 
 ---
 
@@ -834,6 +834,7 @@ ___
 ## License
 
 This project is licensed under the GPL3 License: see the [LICENSE](LICENSE) file for details.
+
 ___
 
 ## Acknowledgments

{sl_shared_assets-1.0.0rc3 → sl_shared_assets-1.0.0rc5}/README.md

@@ -56,7 +56,7 @@ Note, installation from source is ***highly discouraged*** for everyone who is n
    wheel into the active python environment.
 
 ### pip
-Use the following command to install the library using pip: ```pip install sl-experiment```.
+Use the following command to install the library using pip: ```pip install sl-shared-assets```.
 
 ---
 
@@ -85,6 +85,7 @@ ___
 ## License
 
 This project is licensed under the GPL3 License: see the [LICENSE](LICENSE) file for details.
+
 ___
 
 ## Acknowledgments

{sl_shared_assets-1.0.0rc3 → sl_shared_assets-1.0.0rc5}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "hatchling.build"
 # Project metdata section. Provides the genral ID information about the project.
 [project]
 name = "sl-shared-assets"
-version = "1.0.0rc3"
+version = "1.0.0rc5"
 description = "Stores assets shared between multiple Sun (NeuroAI) lab data pipelines."
 readme = "README.md"
 license = { file = "LICENSE" }

{sl_shared_assets-1.0.0rc3 → sl_shared_assets-1.0.0rc5}/src/sl_shared_assets/data_classes.py

@@ -727,31 +727,35 @@ class SessionData(YamlConfig):
         data through acquisition, preprocessing and processing stages of the Sun lab data workflow.
     """
 
+    project_name: str
+    """Stores the name of the managed session's project."""
     animal_id: str
     """Stores the unique identifier of the animal that participates in the managed session."""
+    session_name: str
+    """Stores the name (timestamp-based ID) of the managed session."""
     session_type: str
     """Stores the type of the session. Primarily, this determines how to read the session_descriptor.yaml file. Has 
     to be set to one of the three supported types: 'Lick training', 'Run training' or 'Experiment'.
     """
     experiment_name: str | None
-    """Stores the name of the experiment configuration file. If the session_name field is set to 'Experiment', this 
+    """Stores the name of the experiment configuration file. If the session_type field is set to 'Experiment', this 
     field is used to communicate the specific experiment configuration used by the session. During runtime, this is
     used to load the experiment configuration (to run the experiment) and to save the experiment configuration to the
     session raw_data folder. If the session is not an experiment session, this is statically set to None."""
-    raw_data: RawData | None
+    raw_data: RawData
     """Stores the paths to various directories and files used to store raw and preprocessed session data. Depending on 
     class initialization location (VRPC or BioHPC server), the class automatically resolves the root directory path to 
     either the VRPC project directory or the BioHPC cluster storage volume."""
-    processed_data: ProcessedData | None
+    processed_data: ProcessedData
     """Stores the paths to various directories used to store processed session data. This is automatically 
     resolved to the fast BioHPC volume (workdir) in all cases, as processed data should only exist on the server."""
-    persistent_data: PersistentData | None
+    persistent_data: PersistentData
     """Stores the paths to various files and directories kept on VRPC and ScanImagePC after the session data is 
     transferred to long-term storage destinations."""
-    mesoscope_data: MesoscopeData | None
+    mesoscope_data: MesoscopeData
     """Stores the paths to various directories used by the ScanImagePC to store mesoscope-acquired session data, 
     before it is moved to the VRPC during preprocessing."""
-    destinations: Destinations | None
+    destinations: Destinations
     """Stores the paths to the destination directories on the BioHPC server and Synology NAS, to which the data is 
     copied as part of preprocessing. Both of these directories should be accessible for the VRPC's filesystem via an 
     SMB or equivalent protocol."""
@@ -884,7 +888,9 @@ class SessionData(YamlConfig):
 
         # Packages the sections generated above into a SessionData instance
         instance = SessionData(
+            project_name=project_configuration.project_name,
             animal_id=animal_id,
+            session_name=session_name,
             session_type=session_type,
             raw_data=raw_data,
             processed_data=processed_data,
@@ -898,10 +904,6 @@ class SessionData(YamlConfig):
         # preprocessing
         instance._to_path()
 
-        # Removes the processed_data section, as it is not used on the VRPC. This makes it impossible to accidentally
-        # interact with this section without errors.
-        instance.processed_data = None
-
         # Extracts and saves the necessary configuration classes to the session raw_data folder. Note, this list of
         # classes is not exhaustive. More classes are saved as part of the session runtime management class start() and
         # __init__() method runtimes:
@@ -913,13 +915,13 @@ class SessionData(YamlConfig):
         # Project Configuration
         sh.copy2(
             src=vrpc_configuration_path.joinpath("project_configuration.yaml"),
-            dst=instance.raw_data.project_configuration_path,  # type: ignore
+            dst=instance.raw_data.project_configuration_path,
         )
         # Experiment Configuration, if the session type is Experiment.
         if experiment_name is not None:
             sh.copy2(
                 src=vrpc_configuration_path.joinpath(f"{experiment_name}.yaml"),
-                dst=instance.raw_data.experiment_configuration_path,  # type: ignore
+                dst=instance.raw_data.experiment_configuration_path,
             )
 
         # Returns the initialized SessionData instance to caller
@@ -971,18 +973,12 @@ class SessionData(YamlConfig):
         # well-configured. This is because the class is always created on the VRPC and, when it leaves VRPC, it is
         # never used on VRPC again. Therefore, additional processing is ONLY done when on_server is True.
         if on_server:
-            # Disables VRPC-only sections. This makes it impossible to call these sections on BioHPC server without
-            # runtime interruption.
-            instance.mesoscope_data = None
-            instance.persistent_data = None
-            instance.destinations = None
-
             # Reconfigures the raw_data section to use the root provided as part of the session_path.
-            instance.raw_data.switch_root(new_root=session_path)  # type: ignore
+            instance.raw_data.switch_root(new_root=session_path)
 
             # Processed Data section is always configured to use the BioHPC server root. Calls its' make_dirs() method
             # to setup directories
-            instance.processed_data.make_dirs()  # type: ignore
+            instance.processed_data.make_dirs()
 
         # Returns the initialized SessionData instance to caller
         return instance

{sl_shared_assets-1.0.0rc3 → sl_shared_assets-1.0.0rc5}/src/sl_shared_assets/data_classes.pyi

@@ -313,14 +313,16 @@ class SessionData(YamlConfig):
         data through acquisition, preprocessing and processing stages of the Sun lab data workflow.
     """
 
+    project_name: str
     animal_id: str
+    session_name: str
     session_type: str
     experiment_name: str | None
-    raw_data: RawData | None
-    processed_data: ProcessedData | None
-    persistent_data: PersistentData | None
-    mesoscope_data: MesoscopeData | None
-    destinations: Destinations | None
+    raw_data: RawData
+    processed_data: ProcessedData
+    persistent_data: PersistentData
+    mesoscope_data: MesoscopeData
+    destinations: Destinations
     @classmethod
     def create_session(
         cls,