sapiopycommons 2025.3.26a460__tar.gz → 2025.3.27a461__tar.gz

{sapiopycommons-2025.3.26a460 → sapiopycommons-2025.3.27a461}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.3.26a460
+Version: 2025.3.27a461
 Summary: Official Sapio Python API Utilities Package
 Project-URL: Homepage, https://github.com/sapiosciences
 Author-email: Jonathan Steck <jsteck@sapiosciences.com>, Yechen Qiao <yqiao@sapiosciences.com>

{sapiopycommons-2025.3.26a460 → sapiopycommons-2025.3.27a461}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sapiopycommons"
-version='2025.03.26a460'
+version='2025.03.27a461'
 authors = [
     { name="Jonathan Steck", email="jsteck@sapiosciences.com" },
     { name="Yechen Qiao", email="yqiao@sapiosciences.com" },

{sapiopycommons-2025.3.26a460 → sapiopycommons-2025.3.27a461}/src/sapiopycommons/eln/experiment_handler.py

@@ -590,6 +590,9 @@ class ExperimentHandler:
         """
         Set the experiment's status to Completed. Makes a webservice call to update the experiment. Checks if the
         experiment is already completed, and does nothing if so.
+
+        NOTE: This will cause the usual process tracking logic to run as if you'd clicked the "Complete Experiment"
+        toolbar button. This includes moving the in process samples forward to the next step in the process.
         """
         if not self.experiment_is_complete():
             self._protocol.complete_protocol()
@@ -600,9 +603,11 @@ class ExperimentHandler:
         Set the experiment's status to Canceled. Makes a webservice call to update the experiment. Checks if the
         experiment is already canceled, and does nothing if so.
 
-        NOTE: This will not run the usual logic around canceling an experiment that you'd see if canceling the
-        experiment using the "Cancel Experiment" toolbar button, such as moving in process samples back to the queue,
-        as those changes are tied to the button instead of being on the experiment status change.
+        NOTE: This will cause the usual process tracking logic to run as if you'd clicked the "Cancel Experiment"
+        toolbar button. This includes moving the in process samples back into the process queue for the current step.
+
+        On version 24.12 and earlier, this was not the case, as the process tracking logic was tied to the button
+        instead of being on the experiment status change.
         """
         if not self.experiment_is_canceled():
             self._protocol.cancel_protocol()