Merge 75a6262f18 into ef9e1409c6

* add: legend modification parameters and output DPI

This commit adds a CLI parameter to plot_histogram in order to position
the legend of the plot on the diagram.
It also defines the output DPI for the plot to 600 dpi.

Plot_progression gets a CLI paramter to add a custom label and to
overwrite the default one.

---------

Co-authored-by: dbv <jt@dbv03.linpro.no>
Co-authored-by: dbv <spreadcat.github@micronarrativ.org>

.github/workflows/CICD.yml

@@ -22,17 +22,25 @@ jobs:
     - name: Extract crate information
       id: crate_metadata
       run: |
-        cargo metadata --no-deps --format-version 1 | jq -r '"name=" + .packages[0].name' | tee -a $GITHUB_OUTPUT
-        cargo metadata --no-deps --format-version 1 | jq -r '"version=" + .packages[0].version' | tee -a $GITHUB_OUTPUT
-        cargo metadata --no-deps --format-version 1 | jq -r '"maintainer=" + .packages[0].authors[0]' | tee -a $GITHUB_OUTPUT
-        cargo metadata --no-deps --format-version 1 | jq -r '"homepage=" + .packages[0].homepage' | tee -a $GITHUB_OUTPUT
-        cargo metadata --no-deps --format-version 1 | jq -r '"msrv=" + .packages[0].rust_version' | tee -a $GITHUB_OUTPUT
+        cargo metadata --no-deps --format-version 1 | jq -r '
+          .packages[0] |
+          [
+            "name=" + .name,
+            "version=" + .version,
+            "maintainer=" + (.authors[0] // ""),
+            "homepage=" + (.homepage // ""),
+            "msrv=" + (.rust_version // ""),
+            "bin-name=" + ( (.targets[] | select(.kind[0] == "bin") | .name) // .name )
+          ] |
+          join("\n")
+        ' | tee -a $GITHUB_OUTPUT
     outputs:
       name: ${{ steps.crate_metadata.outputs.name }}
       version: ${{ steps.crate_metadata.outputs.version }}
       maintainer: ${{ steps.crate_metadata.outputs.maintainer }}
       homepage: ${{ steps.crate_metadata.outputs.homepage }}
       msrv: ${{ steps.crate_metadata.outputs.msrv }}
+      bin-name: ${{ steps.crate_metadata.outputs.bin-name }}
 
   ensure_cargo_fmt:
     name: Ensure 'cargo fmt' has been run
@@ -115,6 +123,7 @@ jobs:
     - name: Show version information (Rust, cargo, GCC)
       shell: bash
       run: |
+        set -x
         gcc --version || true
         rustup -V
         rustup toolchain list
@@ -137,7 +146,7 @@ jobs:
         esac;
 
         # Setup paths
-        BIN_NAME="${{ needs.crate_metadata.outputs.name }}${EXE_suffix}"
+        BIN_NAME="${{ needs.crate_metadata.outputs.bin-name }}${EXE_suffix}"
         BIN_PATH="target/${{ matrix.job.target }}/release/${BIN_NAME}"
 
         # Let subsequent steps know where to find the binary
@@ -150,7 +159,7 @@ jobs:
       run: |
         # test only library unit tests and binary for arm-type targets
         unset CARGO_TEST_OPTIONS
-        unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-* | aarch64-*) CARGO_TEST_OPTIONS="--bin ${{ needs.crate_metadata.outputs.name }}" ;; esac;
+        unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-* | aarch64-*) CARGO_TEST_OPTIONS="--bin ${{ steps.bin.outputs.BIN_NAME }}" ;; esac;
         echo "CARGO_TEST_OPTIONS=${CARGO_TEST_OPTIONS}" >> $GITHUB_OUTPUT
 
     - name: Run tests

scripts/plot_histogram.py

@@ -6,6 +6,7 @@ import argparse
 import json
 import numpy as np
 import matplotlib.pyplot as plt
+import matplotlib.font_manager
 
 parser = argparse.ArgumentParser(description=__doc__)
 parser.add_argument("file", help="JSON file with benchmark results")
@@ -14,6 +15,11 @@ parser.add_argument(
     "--labels", help="Comma-separated list of entries for the plot legend"
 )
 parser.add_argument("--bins", help="Number of bins (default: auto)")
+parser.add_argument(
+    "--legend-location", help="Location of the legend on plot (default: upper center)",
+    choices=["upper center", "lower center", "right", "left", "best", "upper left", "upper right", "lower left", "lower right", "center left", "center right", "center"],
+    default="upper center"
+    )
 parser.add_argument(
     "--type", help="Type of histogram (*bar*, barstacked, step, stepfilled)"
 )
@@ -47,6 +53,7 @@ t_max = float(args.t_max) if args.t_max else np.max(list(map(np.max, all_times))
 bins = int(args.bins) if args.bins else "auto"
 histtype = args.type if args.type else "bar"
 
+plt.figure(figsize=(10, 5))
 plt.hist(
     all_times,
     label=labels,
@@ -54,7 +61,12 @@ plt.hist(
     histtype=histtype,
     range=(t_min, t_max),
 )
-plt.legend(prop={"family": ["Source Code Pro", "Fira Mono", "Courier New"]})
+plt.legend(
+        loc=args.legend_location,
+        fancybox=True,
+        shadow=True,
+        prop={"size": 7, "family": ["Source Code Pro", "Fira Mono", "Courier New"]}
+        )
 
 plt.xlabel("Time [s]")
 if args.title:
@@ -66,6 +78,6 @@ else:
     plt.ylim(0, None)
 
 if args.output:
-    plt.savefig(args.output)
+    plt.savefig(args.output, dpi=600)
 else:
     plt.show()