Merge PR #322 (Flag timers that differ by more than +/- 10%)

This merge brings PR #332 (Now flag GEOS-Chem Classic/GCHP timers that differ by more than 10% in the benchmark timing tables, by @yantosca) into the GCPy development stream. This PR does the following: 1. Changes % difference from scientific notation to floating-point notation 2. Adds a "*" character next to timers that differ by more than +/- 10% Signed-off-by: Bob Yantosca <[email protected]>
geoschem · Aug 19, 2024 · f2fe1fe · f2fe1fe
2 parents de83662 + b07327d
commit f2fe1fe
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,9 +5,13 @@ All notable changes to GCPy will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased] - TBD
+### Changed
+- Changed format of `% diff` column from `12.3e` to `12.3f` in benchmark timing tables 
+
 ### Fixed
 - Fixed formatting error in `.github/workflows/stale.yml` that caused the Mark Stale Issues action not to run
 - Added brackets around `exempt-issue-labels` list in `.github/workflows/stale.yml`
+- Now flag differences greater than +/- 10% in benchmark timing table outputs
 
 ## [1.5.0] - 2024-05-29
 ### Added

diff --git a/gcpy/benchmark/modules/benchmark_scrape_gcclassic_timers.py b/gcpy/benchmark/modules/benchmark_scrape_gcclassic_timers.py
@@ -180,7 +180,9 @@ def print_timer(key, ref, dev, ofile):
     pctdiff = np.nan
     if np.abs(ref[key] > 0.0):
         pctdiff = ((dev[key] - ref[key]) / ref[key]) * 100.0
-    line = f"{key:<22}  {ref[key]:>18.3f}  {dev[key]:>18.3f}   {pctdiff:>12.3e}"
+    line = f"{key:<22}  {ref[key]:>18.3f}  {dev[key]:>18.3f}   {pctdiff:>12.3f}"
+    if np.abs(pctdiff) >= 10.0:  # Flag diffs > +/- 10%
+        line += " *"
     print(line, file=ofile)
 
 

diff --git a/gcpy/benchmark/modules/benchmark_scrape_gchp_timers.py b/gcpy/benchmark/modules/benchmark_scrape_gchp_timers.py
@@ -256,7 +256,9 @@ def print_timer(key, ref, dev, ofile):
     if np.abs(ref[key] > 0.0):
         pctdiff = ((dev[key] - ref[key]) / ref[key]) * 100.0
     line = \
-        f"{label:<22}  {ref[key]:>18.3f}  {dev[key]:>18.3f}   {pctdiff:>12.3e}"
+        f"{label:<22}  {ref[key]:>18.3f}  {dev[key]:>18.3f}   {pctdiff:>12.3f}"
+    if np.abs(pctdiff) >= 10.0:  # Flag diffs > +/- 10%
+        line += " *"
     print(line, file=ofile)