bmtool 0.5.7__py3-none-any.whl → 0.5.7.1__py3-none-any.whl

bmtool/SLURM.py

@@ -59,7 +59,12 @@ def submit_job(script_path):
 
 
 def send_teams_message(webhook,message):
-    # Message payload
+    """Sends a message to a teams channel or chat
+
+    Args:
+        webhook (str): A microsoft teams webhook
+        message (str): A message to send in the chat/channel
+    """
     message = {
         "text": f"{message}" 
     }
@@ -256,8 +261,11 @@ export OUTPUT_DIR={case_output_dir}
         return True
     
     def check_block_completed(self):
-        # Implement this method to check if all jobs are completed
-        # This should return True only if all jobs are in the COMPLETED state
+        """checks if all the jobs in the block have been completed by slurm
+
+        Returns:
+            bool: True if all block jobs have been ran, false if job is still running
+        """
         for job_id in self.job_ids:
             status = check_job_status(job_id)
             if status != 'COMPLETED': # can add PENDING here for debugging NOT FOR ACTUALLY USING IT 
@@ -266,8 +274,11 @@ export OUTPUT_DIR={case_output_dir}
 
 
     def check_block_running(self):
-        # Implement this method to check if all jobs are completed
-        # This should return True only if all jobs are in the COMPLETED state
+        """checks if a job is running
+
+        Returns:
+            bool: True if jobs are RUNNING false if anything else
+        """
         for job_id in self.job_ids:
             status = check_job_status(job_id)
             if status != 'RUNNING': # 
@@ -283,6 +294,7 @@ class SequentialBlockRunner:
         blocks (list): List of SimulationBlock instances to be run.
         json_editor (seedSweep or multiSweep): Instance of seedSweep to edit JSON file.
         param_values (list): List of values for the parameter to be modified.
+        webhook (str): a microsoft webhook for teams. When used will send teams messages to the hook!
     """
 
     def __init__(self, blocks, json_editor=None, param_values=None, check_interval=200,webhook=None):
@@ -322,9 +334,8 @@ class SequentialBlockRunner:
                 message = f"SIMULATION UPDATE: Block {i} has been submitted! There are {(len(self.blocks)-1)-i} left to be submitted"
                 send_teams_message(self.webhook,message)
 
-            time.sleep(self.check_interval)
             # Wait for the block to complete
-            if i == len(self.blocks): # we want to wait for the last block to be completed not just running
+            if i == len(self.blocks) - 1:  # Corrected index to check the last block
                 while not block.check_block_completed():
                     print(f"Waiting for the last block {i} to complete...")
                     time.sleep(self.check_interval)

{bmtool-0.5.7.dist-info → bmtool-0.5.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bmtool
-Version: 0.5.7
+Version: 0.5.7.1
 Summary: BMTool
 Home-page: https://github.com/cyneuro/bmtool
 Download-URL: 

{bmtool-0.5.7.dist-info → bmtool-0.5.7.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-bmtool/SLURM.py,sha256=BRCs8RqdKEWDQiW5fdfZMsu91GXj6ExzuztZIWUtY_g,13466
+bmtool/SLURM.py,sha256=AX5MKV7dD-XwS8SROnW1IyesZ3jDwMf0txO6mHxTbuw,13694
 bmtool/__init__.py,sha256=ZStTNkAJHJxG7Pwiy5UgCzC4KlhMS5pUNPtUJZVwL_Y,136
 bmtool/__main__.py,sha256=TmFkmDxjZ6250nYD4cgGhn-tbJeEm0u-EMz2ajAN9vE,650
 bmtool/bmplot.py,sha256=-kw4VOcTnA22JVQi1PzH2E308pcmY1Xo7oqgCnm0cC8,46260
@@ -16,9 +16,9 @@ bmtool/util/commands.py,sha256=zJF-fiLk0b8LyzHDfvewUyS7iumOxVnj33IkJDzux4M,64396
 bmtool/util/util.py,sha256=24E5rUoDU86nqypDF4uZJkuJKO1BrwrQE8lZzAxu1kw,56770
 bmtool/util/neuron/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bmtool/util/neuron/celltuner.py,sha256=xSRpRN6DhPFz4q5buq_W8UmsD7BbUrkzYBEbKVloYss,87194
-bmtool-0.5.7.dist-info/LICENSE,sha256=qrXg2jj6kz5d0EnN11hllcQt2fcWVNumx0xNbV05nyM,1068
-bmtool-0.5.7.dist-info/METADATA,sha256=jZ4-e2K34Bc_af0oHAqG8efiPLA0ErowTOWkDds4tnc,24105
-bmtool-0.5.7.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-bmtool-0.5.7.dist-info/entry_points.txt,sha256=0-BHZ6nUnh0twWw9SXNTiRmKjDnb1VO2DfG_-oprhAc,45
-bmtool-0.5.7.dist-info/top_level.txt,sha256=gpd2Sj-L9tWbuJEd5E8C8S8XkNm5yUE76klUYcM-eWM,7
-bmtool-0.5.7.dist-info/RECORD,,
+bmtool-0.5.7.1.dist-info/LICENSE,sha256=qrXg2jj6kz5d0EnN11hllcQt2fcWVNumx0xNbV05nyM,1068
+bmtool-0.5.7.1.dist-info/METADATA,sha256=cgwZVmUCp3LN20uI_TD0FkTlxfvlNDei3HlW1-PVHi4,24107
+bmtool-0.5.7.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+bmtool-0.5.7.1.dist-info/entry_points.txt,sha256=0-BHZ6nUnh0twWw9SXNTiRmKjDnb1VO2DfG_-oprhAc,45
+bmtool-0.5.7.1.dist-info/top_level.txt,sha256=gpd2Sj-L9tWbuJEd5E8C8S8XkNm5yUE76klUYcM-eWM,7
+bmtool-0.5.7.1.dist-info/RECORD,,