Merge pull request #859 from andrewdnolan/chicoma_debug

Chicoma debug
MPAS-Dev · Sep 13, 2024 · 869dafe · 869dafe
2 parents a7e6d98 + 5fab513
commit 869dafe
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 3 deletions.
diff --git a/compass/job/__init__.py b/compass/job/__init__.py
@@ -82,6 +82,11 @@ def write_job_script(config, machine, target_cores, min_cores, work_dir,
         else:
             constraint = ''
 
+    if config.has_option('job', 'reservation'):
+        reservation = config.get('job', 'reservation')
+    else:
+        reservation = ''
+
     job_name = config.get('job', 'job_name')
     if job_name == '<<<default>>>':
         if suite == '':
@@ -96,7 +101,8 @@ def write_job_script(config, machine, target_cores, min_cores, work_dir,
     text = template.render(job_name=job_name, account=account,
                            nodes=f'{nodes}', wall_time=wall_time, qos=qos,
                            partition=partition, constraint=constraint,
-                           suite=suite, pre_run_commands=pre_run_commands,
+                           reservation=reservation, suite=suite,
+                           pre_run_commands=pre_run_commands,
                            post_run_commands=post_run_commands)
     text = _clean_up_whitespace(text)
     if suite == '':

diff --git a/compass/job/job_script.template b/compass/job/job_script.template
@@ -10,6 +10,9 @@
 {% if qos != '' -%}
 #SBATCH  --qos={{ qos }}
 {%- endif %}
+{% if reservation != '' -%}
+#SBATCH  --reservation={{ reservation }}
+{%- endif %}
 {% if partition != '' -%}
 #SBATCH  --partition={{ partition }}
 {%- endif %}

diff --git a/compass/machines/chicoma-cpu.cfg b/compass/machines/chicoma-cpu.cfg
@@ -51,5 +51,8 @@ threads_per_core = 1
 # The job partition to use
 partition = standard
 
+# The job reservation to use (needed for debug jobs)
+reservation =
+
 # The job quality of service (QOS) to use
 qos = standard
diff --git a/docs/developers_guide/machines/chicoma.rst b/docs/developers_guide/machines/chicoma.rst
@@ -19,3 +19,22 @@ Then, you can build the MPAS model with
 .. code-block:: bash
 
     make [DEBUG=true] gnu-cray
+
+debug jobs
+~~~~~~~~~~
+
+In order to run jobs in the debug queue, you will need to use: 
+
+.. code-block:: cfg
+
+    # Config options related to creating a job script
+    [job]
+
+    # The job partition to use
+    partition = debug
+
+    # The job reservation to use (needed for debug jobs)
+    reservation = debug
+
+    # The job quality of service (QOS) to use
+    qos =
diff --git a/docs/users_guide/machines/chicoma.rst b/docs/users_guide/machines/chicoma.rst
@@ -138,9 +138,12 @@ when setting up test cases or a test suite:
     # The job partition to use
     partition = standard
 
+    # The job reservation to use (needed for debug jobs)
+    reservation =
+
     # The job quality of service (QOS) to use
     qos = standard
-
+    
 
 Additionally, some relevant config options come from the
 `mache <https://github.com/E3SM-Project/mache/>`_ package:
@@ -213,4 +216,4 @@ To build the MPAS model with
 
 .. code-block:: bash
 
-    make [DEBUG=true] [OPENMP=true] [ALBANY=true] gnu-cray
+    make [DEBUG=true] [OPENMP=true] [ALBANY=true] gnu-cray