sl-shared-assets 3.0.0rc6__tar.gz → 3.0.0rc7__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of sl-shared-assets might be problematic. Click here for more details.

Files changed (45) hide show
  1. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/PKG-INFO +1 -1
  2. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/pyproject.toml +1 -1
  3. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/session_data.py +5 -19
  4. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/session_data.pyi +3 -5
  5. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/.gitignore +0 -0
  6. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/LICENSE +0 -0
  7. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/README.md +0 -0
  8. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/docs/Makefile +0 -0
  9. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/docs/make.bat +0 -0
  10. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/docs/source/api.rst +0 -0
  11. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/docs/source/conf.py +0 -0
  12. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/docs/source/index.rst +0 -0
  13. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/docs/source/welcome.rst +0 -0
  14. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/envs/slsa_dev_lin.yml +0 -0
  15. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/envs/slsa_dev_lin_spec.txt +0 -0
  16. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/__init__.py +0 -0
  17. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/__init__.pyi +0 -0
  18. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/cli.py +0 -0
  19. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/cli.pyi +0 -0
  20. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/__init__.py +0 -0
  21. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/__init__.pyi +0 -0
  22. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/configuration_data.py +0 -0
  23. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/configuration_data.pyi +0 -0
  24. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/runtime_data.py +0 -0
  25. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/runtime_data.pyi +0 -0
  26. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/surgery_data.py +0 -0
  27. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/data_classes/surgery_data.pyi +0 -0
  28. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/py.typed +0 -0
  29. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/server/__init__.py +0 -0
  30. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/server/__init__.pyi +0 -0
  31. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/server/job.py +0 -0
  32. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/server/job.pyi +0 -0
  33. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/server/server.py +0 -0
  34. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/server/server.pyi +0 -0
  35. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/__init__.py +0 -0
  36. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/__init__.pyi +0 -0
  37. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/ascension_tools.py +0 -0
  38. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/ascension_tools.pyi +0 -0
  39. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/packaging_tools.py +0 -0
  40. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/packaging_tools.pyi +0 -0
  41. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/project_management_tools.py +0 -0
  42. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/project_management_tools.pyi +0 -0
  43. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/transfer_tools.py +0 -0
  44. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/src/sl_shared_assets/tools/transfer_tools.pyi +0 -0
  45. {sl_shared_assets-3.0.0rc6 → sl_shared_assets-3.0.0rc7}/tox.ini +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sl-shared-assets
3
- Version: 3.0.0rc6
3
+ Version: 3.0.0rc7
4
4
  Summary: Provides data acquisition and processing assets shared between Sun (NeuroAI) lab libraries.
5
5
  Project-URL: Homepage, https://github.com/Sun-Lab-NBB/sl-shared-assets
6
6
  Project-URL: Documentation, https://sl-shared-assets-api-docs.netlify.app/
@@ -8,7 +8,7 @@ build-backend = "hatchling.build"
8
8
  # Project metdata section. Provides the genral ID information about the project.
9
9
  [project]
10
10
  name = "sl-shared-assets"
11
- version = "3.0.0rc6"
11
+ version = "3.0.0rc7"
12
12
  description = "Provides data acquisition and processing assets shared between Sun (NeuroAI) lab libraries."
13
13
  readme = "README.md"
14
14
  license = { file = "LICENSE" }
@@ -68,9 +68,6 @@ class RawData:
68
68
  surgery_metadata_path: Path = Path()
69
69
  """Stores the path to the surgery_metadata.yaml file. This file contains the most actual information about the
70
70
  surgical intervention(s) performed on the animal prior to the session."""
71
- project_configuration_path: Path = Path()
72
- """Stores the path to the project_configuration.yaml file. This file contains the snapshot of the configuration
73
- parameters for the session's project."""
74
71
  session_data_path: Path = Path()
75
72
  """Stores the path to the session_data.yaml file. This path is used by the SessionData instance to save itself to
76
73
  disk as a .yaml file. The file contains the paths to all raw and processed data directories used during data
@@ -110,9 +107,6 @@ class RawData:
110
107
  """Stores the path to the integrity_verification.yaml tracker file. This file stores the current state of the data
111
108
  integrity verification pipeline. It prevents more than one instance of the pipeline from working with the data
112
109
  at a given time and communicates the outcome (success or failure) of the most recent pipeline runtime."""
113
- version_data_path: Path = Path()
114
- """Stores the path to the version_data.yaml file. This file contains the snapshot of Python and sl-experiment
115
- library versions that were used when the data was acquired."""
116
110
 
117
111
  def resolve_paths(self, root_directory_path: Path) -> None:
118
112
  """Resolves all paths managed by the class instance based on the input root directory path.
@@ -135,7 +129,6 @@ class RawData:
135
129
  self.session_descriptor_path = self.raw_data_path.joinpath("session_descriptor.yaml")
136
130
  self.hardware_state_path = self.raw_data_path.joinpath("hardware_state.yaml")
137
131
  self.surgery_metadata_path = self.raw_data_path.joinpath("surgery_metadata.yaml")
138
- self.project_configuration_path = self.raw_data_path.joinpath("project_configuration.yaml")
139
132
  self.session_data_path = self.raw_data_path.joinpath("session_data.yaml")
140
133
  self.experiment_configuration_path = self.raw_data_path.joinpath("experiment_configuration.yaml")
141
134
  self.mesoscope_positions_path = self.raw_data_path.joinpath("mesoscope_positions.yaml")
@@ -145,7 +138,6 @@ class RawData:
145
138
  self.telomere_path = self.raw_data_path.joinpath("telomere.bin")
146
139
  self.ubiquitin_path = self.raw_data_path.joinpath("ubiquitin.bin")
147
140
  self.integrity_verification_tracker_path = self.raw_data_path.joinpath("integrity_verification_tracker.yaml")
148
- self.version_data_path = self.raw_data_path.joinpath("version_data.yaml")
149
141
 
150
142
  def make_directories(self) -> None:
151
143
  """Ensures that all major subdirectories and the root directory exist, creating any missing directories."""
@@ -302,9 +294,9 @@ class SessionData(YamlConfig):
302
294
 
303
295
  This method automatically dumps the data of the created SessionData instance into the session_data.yaml file
304
296
  inside the root raw_data directory of the created hierarchy. It also finds and dumps other configuration
305
- files, such as project_configuration.yaml, experiment_configuration.yaml, and system_configuration.yaml into
306
- the same raw_data directory. This ensures that if the session's runtime is interrupted unexpectedly, the
307
- acquired data can still be processed.
297
+ files, such as experiment_configuration.yaml and system_configuration.yaml into the same raw_data directory.
298
+ This ensures that if the session's runtime is interrupted unexpectedly, the acquired data can still be
299
+ processed.
308
300
 
309
301
  Args:
310
302
  project_name: The name of the project for which the data is acquired.
@@ -401,14 +393,8 @@ class SessionData(YamlConfig):
401
393
  # preprocessing.
402
394
  instance._save()
403
395
 
404
- # Also saves the ProjectConfiguration, SystemConfiguration, and ExperimentConfiguration instances to the same
405
- # folder using the paths resolved for the RawData instance above.
406
-
407
- # Copies the project_configuration.yaml file to session's folder
408
- project_configuration_path = acquisition_system.paths.root_directory.joinpath(
409
- project_name, "configuration", "project_configuration.yaml"
410
- )
411
- sh.copy2(project_configuration_path, instance.raw_data.project_configuration_path)
396
+ # Also saves the SystemConfiguration and ExperimentConfiguration instances to the same folder using the paths
397
+ # resolved for the RawData instance above.
412
398
 
413
399
  # Dumps the acquisition system's configuration data to session's folder
414
400
  acquisition_system.save(path=instance.raw_data.system_configuration_path)
@@ -29,7 +29,6 @@ class RawData:
29
29
  session_descriptor_path: Path = ...
30
30
  hardware_state_path: Path = ...
31
31
  surgery_metadata_path: Path = ...
32
- project_configuration_path: Path = ...
33
32
  session_data_path: Path = ...
34
33
  experiment_configuration_path: Path = ...
35
34
  mesoscope_positions_path: Path = ...
@@ -39,7 +38,6 @@ class RawData:
39
38
  telomere_path: Path = ...
40
39
  ubiquitin_path: Path = ...
41
40
  integrity_verification_tracker_path: Path = ...
42
- version_data_path: Path = ...
43
41
  def resolve_paths(self, root_directory_path: Path) -> None:
44
42
  """Resolves all paths managed by the class instance based on the input root directory path.
45
43
 
@@ -140,9 +138,9 @@ class SessionData(YamlConfig):
140
138
 
141
139
  This method automatically dumps the data of the created SessionData instance into the session_data.yaml file
142
140
  inside the root raw_data directory of the created hierarchy. It also finds and dumps other configuration
143
- files, such as project_configuration.yaml, experiment_configuration.yaml, and system_configuration.yaml into
144
- the same raw_data directory. This ensures that if the session's runtime is interrupted unexpectedly, the
145
- acquired data can still be processed.
141
+ files, such as experiment_configuration.yaml and system_configuration.yaml into the same raw_data directory.
142
+ This ensures that if the session's runtime is interrupted unexpectedly, the acquired data can still be
143
+ processed.
146
144
 
147
145
  Args:
148
146
  project_name: The name of the project for which the data is acquired.