pito-compare

There is no plotting library: the canvas, the 5x7 pixel font and the PNG writer are a few hundred lines of Rust, so a chart is drawn the same, pixel for pixel, on every machine.

v=$(basename "$(curl -fsSLo /dev/null -w '%{url_effective}' https://github.com/gmrdad82/pito-compare/releases/latest)")
mkdir -p ~/.local/bin && curl -fsSL "https://github.com/gmrdad82/pito-compare/releases/download/$v/pcmp-$v-linux-x86_64.tar.gz" | tar -xz -C ~/.local/bin pcmp

v=$(basename "$(curl -fsSLo /dev/null -w '%{url_effective}' https://github.com/gmrdad82/pito-compare/releases/latest)")
mkdir -p ~/.local/bin && curl -fsSL "https://github.com/gmrdad82/pito-compare/releases/download/$v/pcmp-$v-macos-arm64.tar.gz" | tar -xz -C ~/.local/bin pcmp

$v = (Invoke-RestMethod https://api.github.com/repos/gmrdad82/pito-compare/releases/latest).tag_name
Invoke-WebRequest "https://github.com/gmrdad82/pito-compare/releases/download/$v/pcmp-$v-windows-x86_64.zip" -OutFile "$env:TEMP\pcmp.zip"
Expand-Archive "$env:TEMP\pcmp.zip" "$env:LOCALAPPDATA\pcmp" -Force
[Environment]::SetEnvironmentVariable('Path', [Environment]::GetEnvironmentVariable('Path', 'User') + ";$env:LOCALAPPDATA\pcmp", 'User')

On Linux and macOS, ~/.local/bin needs to be on your PATH; on Windows, open a new terminal afterwards. From source, on any of the three, with Rust 1.97 or newer: cargo install --locked --git https://github.com/gmrdad82/pito-compare --tag v1.1.2 pito-compare. pcmp needs nothing else to run.

Your first chart

title = "PARSE SPEED"
unit = "MEGABYTES PER SECOND"
better = "higher"
suffix = " MB/S"
parties = [{ name = "PARSER V2" }, { name = "PARSER V1" }]
rows = [
  { label = "CONFIG FILES", values = [612, 240] },
  { label = "LOG LINES", values = [455, 420] },
  { label = "DATA DUMPS", values = [1210, 388] },
]

$ pcmp demo.toml --out charts
charts/demo-paired.png
charts/demo-ratio.png

pcmp <DATA> [--out DIR] [--kind all|paired|ratio|bars]

In a Rust project

[dependencies]
pito-compare = { git = "https://github.com/gmrdad82/pito-compare", tag = "v1.1.2", default-features = false }

use pito_compare::{Better, Chart, Group, Kind, Row};

let mut chart = Chart::new("DECODE SPEED", "FRAMES PER SECOND", Better::Higher, &["OURS", "THEIRS"]);
chart.suffix = " FPS".into();
chart.groups.push(Group { name: "CPU".into(), rows: vec![Row::new("H.264 1080P", &[412.0, 298.0])] });
for (kind, canvas) in pito_compare::render(&chart, Kind::All)? {
    canvas.save(format!("decode-{kind}.png").as_ref())?;
}

default-features = false leaves out the command line and its clap.

1. 01

   Paired bars

   Every party's value on one shared linear axis from zero, the value beside each bar, and per row how many times faster or slower the first party is than the one it is compared with.

   Rows fall under group headings, a row can carry a mark such as * or †, and notes under the chart explain them.

   More on charts

   

2. 02

   Three or more parties

   Up to 12 parties on the same axis. versus names the one the first party's tags compare with, so a third party can stand there for scale; better = "lower" turns the axis for times and latencies.

   

3. 03

   Balanced ratios

   1× in the middle, slower to the left and faster to the right on a symmetric log scale, so 3× slower is as long as 3× faster. pcmp draws it next to the paired bars for any data with two or more parties.

   

4. 04

   Single bars

   One party's values, when there is nothing to compare. --kind bars with several parties draws one chart per party.

   

5. 05

   Your colours

   A party's colour is any #RRGGBB or one of the chart's roles (ours, theirs, dim, text, faster, slower); the legend and the bars follow it. The charts on these pages wear each project's own colour.

   

6. 06

   Never a wrong chart

   Any character the font can't draw, an unknown key, a negative value or text too long for its line is refused with one line naming the file and the field, and no PNG is written.

   Exit 0 when every chart was drawn, 1 when the data couldn't be read or drawn, 2 when the command line is wrong. pcmp's tests draw every chart in its README and compare it with the image there.

   More on never wrong

   $ pcmp bad.toml
   pcmp: bad.toml: groups[0].rows[0].values holds -612: values are finite and zero or more

• pito-codecs

  Where its look comes from

  pito-compare is the chart drawer of pito-codecs' benchmarks made into a tool, with its exact look. It draws every chart on pito-codecs' page and README.

  See pito-codecs' speed
• prec

  prec against VHS

  The frames, re-render and size charts on prec's page come from pcmp, drawn from prec's bench data.

  See prec's speed
• pito-tui

  Frame times

  pito-tui's frame-time charts, average and worst of 1,000 frames, are pcmp's too.

  See pito-tui's speed