Deployed 11eb563 with MkDocs version: 1.6.1

ARCHER2-HPC · Dec 16, 2024 · 0e14cb6 · 0e14cb6
1 parent a26e653
commit 0e14cb6
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 3 deletions.
diff --git a/search/search_index.json b/search/search_index.json
diff --git a/user-guide/energy/index.html b/user-guide/energy/index.html
@@ -996,6 +996,15 @@
     <nav class="md-nav" aria-label="Estimating your emissions">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#emissions-tool" class="md-nav__link">
+    <span class="md-ellipsis">
+      emissions tool
+    </span>
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#jobemissions-tool" class="md-nav__link">
     <span class="md-ellipsis">
@@ -2608,6 +2617,15 @@
     <nav class="md-nav" aria-label="Estimating your emissions">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#emissions-tool" class="md-nav__link">
+    <span class="md-ellipsis">
+      emissions tool
+    </span>
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#jobemissions-tool" class="md-nav__link">
     <span class="md-ellipsis">
@@ -3068,11 +3086,68 @@ <h3 id="estimating-your-emissions">Estimating your emissions</h3>
 this section of the documentation as they become available.</p>
 <p>At the moment, the following tools are available:</p>
 <ul>
+<li><code>emissions</code> - a command line tool on ARCHER2 that reports estimated emissions over a defined
+  date range for a specifed user, budget code or project. It can also provide comparisons to
+  other GHG emissions sources.</li>
 <li><code>jobemissions</code> - a command line tool on ARCHER2 that reports estimated emissions for a specified,
-  completed job. It can also provide comparisons to other GHG emissions sources</li>
+  completed job. It can also provide comparisons to other GHG emissions sources.</li>
 <li><a href="https://www.archer2.ac.uk/support-access/cu-calc.html">ARCHER2 CU Calculator</a> provides estimated
-  emissions for the specified CU use of ARCHER2</li>
+  emissions for the specified CU use of ARCHER2.</li>
 </ul>
+<h4 id="emissions-tool"><code>emissions</code> tool</h4>
+<p>The <code>emissions</code> tool is available by default to all ARCHER2 users from the command line. You
+supply a date range and a classifier (user, budget code or project) and the tool provides an
+estimate of the GHG emissions associated with all jobs that ran in the date range belonging
+to the supplied classifier (based on the estimation methodologies described above). For example,
+to provide an emissions estimate for all jobs run by the user <code>auser</code> in November 2024:</p>
+<div class="highlight"><pre><span></span><code>emissions<span class="w"> </span>--start<span class="o">=</span><span class="m">2024</span>-11-01T00:00<span class="w"> </span>--end<span class="o">=</span><span class="m">2024</span>-12-01T00:00<span class="w"> </span>--type<span class="o">=</span>user<span class="w"> </span>auser
+</code></pre></div>
+<p>Typical output from the tool would look like:</p>
+<div class="highlight"><pre><span></span><code>  Period details:
+                         User:                auser
+                 Period start:     2024-11-01T00:00
+                   Period end:     2024-12-01T00:00
+                         Jobs:                  699
+                           CU:             3565.100
+      Compute node energy use:             1461.691 kWh
+    Other hardware energy use:              219.254 kWh (estimated)
+          Overhead energy use:              168.094 kWh (estimated)
+             Total energy use:             1849.039 kWh (estimated)
+
+  Emissions estimates:
+      Scope 2:      0.000 kgCO2e (ARCHER2 is on 100% certified
+                renewable energy contract so scope 2 emissions are zero)
+      Scope 3:     81.997 kgCO2e (23.0 gCO2e/CU)
+        Total:     81.997 kgCO2e
+
+      Indicative emissions estimates for UK national grid energy mix
+      in S. Scotland at start of job if ARCHER2 was not using
+      renewable energy
+          Scope 2:     58.812 kgCO2e (1849.039 kWh)
+             Carbon Intensities (gCO2e/kWh): Q1: 4.0, Median: 36.5, Q3: 73.0
+          Scope 3:     81.997 kgCO2e (23.0 gCO2e/CU)
+            Total:    140.809 kgCO2e
+
+      Scope 2 carbon intensity values from carbonintensity.org.uk
+</code></pre></div>
+<p>If you add the flag <code>--comparison food,other</code> the tool will add comparisons of
+GHG emissions to other sources. e.g. for the same user report above, it 
+would add the following section to the end of the output.</p>
+<div class="highlight"><pre><span></span><code>   Emissions from job approximately equivalent to following food consumption:
+        |      Food |  Emissions (kgCO2e/100g) | Equivalent to (g) |
+        |-----------|--------------------------|-------------------|
+        |      Beef |                    12.47 |            657.56 |
+        |   Chicken |                     1.43 |           5734.08 |
+        |   Avocado |                     0.18 |          45554.05 |
+        | Chickpeas |                     0.04 |         204993.23 |
+
+  Emissions from job approximately equivalent to:
+        Daily emissions from 303.7 houses&#39; electricity use (in S. Scotland)
+        Emissions from flying 0.164 times across the Atlantic (500.00 kgCO2e/person)
+        Emissions from driving 304.8 miles (0.27 kgCO2e/mile, average UK car, petrol and diesel very similar)
+</code></pre></div>
+<p>You can add the <code>--json</code> flag to obtain the emissions data from the tool in a machine-readable
+format.</p>
 <h4 id="jobemissions-tool"><code>jobemissions</code> tool</h4>
 <p>The <code>jobemissions</code> tool is available by default to all ARCHER2 users from the command line. You
 supply a Slurm job ID for a completed job and the tool provides an estimate of the GHG emissions