[feature] Option to print job ID in log when starting

CHANGELOG.md

@@ -1,6 +1,11 @@
 
 ## Changelog
 
+### [v0.5] - 2024-03-27
+
+- Option to print job ID in log when starting.
+
+
 ### [v0.4] - 2024-01-17
 
 - Job dependencies that are list or tuples are automatically formatted as `afterok:jobid1:jobid2:...`

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="znamutils",
-    version="v0.4-dev",
+    version="v0.5",
     packages=find_packages(exclude=["tests"]),
     url="https://github.com/znamlab/znamutils",
     license="MIT",

tests/test_slurm_helpers.py

@@ -9,3 +9,16 @@
 
 def test_create_slurm_sbatch():
     p = Path(flz.PARAMETERS["data_root"]["processed"]) / "test"
+    slurm_helper.create_slurm_sbatch(
+        p,
+        print_job_id=True,
+        conda_env="cottage_analysis",
+        python_script="test.py",
+        script_name="test.sh",
+    )
+    with open(p / "test.sh") as f:
+        txt = f.read()
+
+
+if __name__ == "__main__":
+    test_create_slurm_sbatch()

znamutils/slurm_helper.py

@@ -40,6 +40,7 @@ def create_slurm_sbatch(
     slurm_options=None,
     module_list=None,
     split_err_out=False,
+    print_job_id=False,
 ):
     """Create a slurm sh script that will call a python script
 
@@ -83,6 +84,10 @@ def create_slurm_sbatch(
             boiler = "\n" + "\n".join([f"ml {module}" for module in module_list]) + "\n"
         else:
             boiler = "\n"
+
+        if print_job_id:
+            boiler += f'echo "Job ID: $SLURM_JOB_ID"\n'
+
         boiler += "\n".join(
             [
                 "ml Anaconda3",