WIP

Author: mgmeier

bench/locli/report-templates/typst/main_comparison.ede

@@ -1,47 +1,69 @@
-#set page(paper: "a4")
+// To be able to load CDF data for plotting from other runs, you need to make
+// the root for compiling the document somewhat more permissive:
+//
+// $ typst c --root ../.. {{ typstFile }}
 
-// these settings make the output look more LaTeX-like
-// #set page(margin: 1.75in)
-#set par(leading: 0.55em, spacing: 0.55em, first-line-indent: 1.8em, justify: true)
-// #set text(font: "Ubuntu")
-// #show raw: set text(font: "Ubuntu Mono")
-#show heading: set block(above: 1.5em, below: 1.2em)
 
+// The suggested file name for the report PDF; you can query this by using
+// $ typst query --one --field value {{ typstFile }} '<export_file_name>'
+//
 #metadata("{{ report.tag }}.{{ base.fileInfix }}.pdf") <export_file_name>
 
 
-// Semibold row descriptions
-#show table.cell.where(x: 0): set text(weight: "semibold")
+// START PREAMBLE
+
+
+#import "@preview/neoplot:0.0.4" as gnuplot
+
+
+// Document Styling
+//
+#set page(paper: "a4", margin: 1.5cm)
+#set text(size: 10pt)
+#set par(leading: 0.6em, spacing: 0.8em, first-line-indent: 1.8em, justify: true)
+#show heading: set block(above: 1.5em, below: 1.2em)
+#show figure.caption: emph
+
 
-// No strokes inside table body; left alignment for row descriptions only
+// Table styling
+// No strokes inside table body; left alignment for row descriptions only; slightly smaller row descriptions
+//
 #let frame(stroke) = (x, y) => (
   left: if x > 0 { 0pt } else { stroke },
   right: stroke,
   top: if y < 2 { stroke } else { 0pt },
   bottom: stroke,
 )
 #set table(
-  stroke: frame(1pt),
-  align:  (x, _) => if x == 0 { left } else { right }
+  stroke: frame(0.5pt),
+  align:  (x, _) => if x == 0 { left } else { right },
 )
+// supposed to do the trick, but doesn't :( #show table: set par(leading: 0.4em)
+#show table.cell.where(x: 0): set text(size: 0.95em)
 
-// table coloring
-#let gr(c) = table.cell(fill: green.lighten(60%))[c]
 
+// Table cell coloring
+// The function names have to be in sync with Cardano.Report.colorCode in package locli
+//
+#let gr(body) = table.cell(fill: green.lighten(60%))[#body]
+#let rd(body) = table.cell(fill: red.lighten(60%))[#body]
 
-//   #+CONSTANTS: base=../../{{ base.meta.tag }}/analysis
-//   {% for run in runs %}
-//   #+CONSTANTS: run{{ run.index }}=../../{{ run.value.meta.tag }}/analysis
+// END PREAMBLE
 
 
+#align(center + horizon)[
+  #text(size: 24pt)[
+  {{ report.target }} against {{ base.ver }}
+  ]
 
-The Title Page
-
-{{ report.target }} against {{ base.ver }}
-
-{{ base.workload }} workload
-{{ report.author }}, Cardano Performance team
-{{ report.date }}
+  #text(size: 16pt)[
+  {{ base.workload }} workload \
+  #pad(top: 50%,[
+    {{ report.author }}, Cardano Performance & Tracing \
+    {{ report.date }}
+  ])
+  ]
+]
 
 #pagebreak()
 
@@ -55,14 +77,23 @@ The Title Page
 
 = Manifest
 
+#pad(bottom: 10pt,[
 We compare {% for run in runs %}{%if !run.first%}{%if !run.last%}, {%else%} and {%endif%}{%endif%}`{{ run.value.ver }}` ({{ run.value.meta.era | toTitle }}){% endfor %} relative to `{{ base.ver }}` ({{ base.meta.era | toTitle }}), under {{ base.workload }} workload.
+])
 
 {% include "table_summary.ede" with table = summary %}
 
 #pagebreak()
 
 = Analysis
 
+{% for section in analyses %}
+== {{ section.value.title }}
+
+{% include "table_summary.ede" with table = section.value %}
+#pad(top: 10pt)[]
+
+{% endfor %}
 
 #pagebreak()
 
@@ -92,6 +123,9 @@ We compare {% for run in runs %}{%if !run.first%}{%if !run.last%}, {%else%} and
 
 == Cluster performance charts
 
+{% for c in charts %}
+{%include "report_gnuplot.ede" with chart = c.value %}
+{% endfor %}
 
 #pagebreak()
 

bench/locli/report-templates/typst/report_gnuplot.ede

@@ -0,0 +1,35 @@
+
+{% for run in runs %}
+#let input_{{ run.index }} = read("../../{{ run.value.meta.tag }}/analysis/cdf/{{ chart.deField }}.cdf")
+{% endfor %}
+#figure(
+  gnuplot.exec(
+    ```gnuplot
+    reset
+    set term svg size 800,512 lw 0.8
+    set title "{{ chart.deField }}"
+    set style data linespoints
+    set ytics nomirror
+
+    set xrange [*:*]
+
+{% for run in runs %}
+    $input_{{ run.index }} <<EOD
+
+    ```.text + input_{{ run.index }} + ```gnuplot
+
+    EOD
+{% endfor %}
+
+    set ylabel "Centile, fraction of sample population"
+    set xlabel "{{ chart.deUnit }}" 
+    plot \
+{% for run in runs %}
+      $input_{{ run.index }} using 2:1 t '{{ run.value.meta.ident }}', \
+{% endfor %}
+
+    ```.text
+  ),
+  caption: "{{ chart.deShortDesc }}",
+  gap: 0.45em,
+)

bench/locli/report-templates/typst/table_summary.ede

@@ -1,5 +1,5 @@
 
-
+#align(center)[
 #table(
   columns: {{ table.header | length }},
 
@@ -11,3 +11,4 @@
     {% for col in row.value %}{{ col.value.cont | justifyRight(col.value.width) }},  {% endfor %}
 {% endfor %}
 )
+]

bench/locli/src/Cardano/Analysis/API/Field.hs

@@ -6,7 +6,7 @@ import Cardano.Prelude          hiding (head, show)
 
 import Data.CDF
 import Data.String                     (fromString)
-import Data.Text                       (unpack)
+import Data.Text                       (pack, unpack)
 
 import Cardano.JSON
 import Cardano.Util
@@ -58,11 +58,11 @@ renderUnit :: Unit -> Text
 renderUnit = \case
     Sec -> "s"
     Hz  -> "Hz"
-    B   -> "B"
-    KB  -> "KB"
-    MB  -> "MB"
-    KBs -> "KB/s"
-    MBs -> "MB/s"
+    B   -> "Bytes"
+    KB  -> "KiB"
+    MB  -> "MiB"
+    KBs -> "KiB/s"
+    MBs -> "MiB/s"
     Era -> "era"
     Epo -> "epoch"
     Slo -> "slots"
@@ -71,16 +71,16 @@ renderUnit = \case
     Hos -> "host"
     Sig -> "+/-"
     Pct -> "%"
-    Ev  -> "#"
-    KEv -> "#"
+    Ev  -> "events"
+    KEv -> "10³ events"
     Dat -> "on"
     Tim -> "at"
     Ver -> "v"
     Ix  -> "[]"
-    Len -> "#"
-    Cnt -> "#"
-    Rto -> "/"
-    Uni -> "#"
+    Len -> "items"
+    Cnt -> "count"
+    Rto -> pack "\x2236"
+    Uni -> "units"
     Id  -> ""
 
 data Width

bench/locli/src/Cardano/Analysis/API/Metrics.hs

@@ -324,11 +324,11 @@ instance CDFFields BlockProp p where
       "For each host, number of blocks made during the entire observation period"
 
     , fGrpF' "cdfBlocksFilteredRatio" "fltrd" Rto P3 Lin R01 (DFloat cdfBlocksFilteredRatio)
-      "Filtered to chained block ratio"
+      "Filtered to chained blocks"
       "For each host, ratio of blocks that passed filtering / all on chain"
 
     , fGrpF' "cdfBlocksChainedRatio" "chaind" Rto P3 Lin R01 (DFloat cdfBlocksChainedRatio)
-      "Chained to forged block ratio"
+      "Chained to forged blocks"
       "For each host, ratio of blocks that made into chain / all forged"]
 
    <> fBoth "cdfBlockBattle"  "Battl" " #" W4 Blk P0 Lin Free (DInt cdfBlockBattle)

bench/locli/src/Cardano/Command.hs

@@ -854,22 +854,19 @@ runChainCommand s c@(Compare ede mTmpl outf@(TextOutputFile outfp) runs) = do
   liftIO . unlessM (IO.fileExist tmplPath) $
     BS.writeFile tmplPath tmpl
 
-  (tmpl', tmplEnv', typstReport) <- case xs of
+
+  let typstPath = Cardano.Util.replaceExtension outfp "typ"
+  (tmplEnv', typstReport) <- case xs of
     baseline:deltas@(_:_) -> liftIO $ do
-      Cardano.Report.generateTypst ede mTmpl baseline deltas
+      Cardano.Report.generateTypst (takeFileName typstPath) baseline deltas
     _ -> throwE $ CommandError c $ mconcat
          [ "At least two runs required for comparison." ]
   liftIO $
     withFile (outfp `System.FilePath.replaceExtension` "env.typ.json") WriteMode $
       \hnd -> BS8.hPutStrLn hnd tmplEnv'
-  let typstPath = Cardano.Util.replaceExtension outfp "typ"
   dumpText "report" [typstReport] (TextOutputFile typstPath)
     & firstExceptT (CommandError c)
 
-  let tmplPath' = Cardano.Util.replaceExtension outfp "typ.ede"
-  liftIO . unlessM (IO.fileExist tmplPath) $
-    BS.writeFile tmplPath' tmpl'
-
   pure s
 
 missingCommandData :: ChainCommand -> [String] -> ExceptT CommandError IO a