https://github.com/alacritty/vtebench

Generate benchmarks for terminal emulators
https://github.com/alacritty/vtebench

benchmark rust terminal vte

Last synced: 16 days ago
JSON representation

Generate benchmarks for terminal emulators

• Host: GitHub
• URL: https://github.com/alacritty/vtebench
• Owner: alacritty
• License: apache-2.0
• Created: 2017-12-25T21:43:03.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-09-17T13:30:04.000Z (about 2 years ago)
• Last Synced: 2024-04-14T09:55:57.008Z (7 months ago)
• Topics: benchmark, rust, terminal, vte
• Language: Rust
• Size: 174 KB
• Stars: 291
• Watchers: 12
• Forks: 17
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# vtebench

A tool for benchmarking terminal emulator PTY read performance.

## Disclaimer

This benchmark is not sufficient to get a general understanding of the

performance of a terminal emulator. It lacks support for critical factors like

frame rate or latency. The only factor this benchmark stresses is the speed at

which a terminal reads from the PTY. If you do not understand what this means,

please do not jump to any conclusions from the results of this benchmark.

## Usage

vtebench accepts benchmarks as executables and uses their stdout as benchmark

payload. By default benchmarks are read from the `./benchmarks` directory, which

contains a good selection of benchmarks already. Benchmarks in vtebench are

defined as a directory with a `benchmark` and an optional `setup` executable.

To just run all the default benchmarks in the repository, you can run the

following after setting up a Rust toolchain:

```

cargo run --release

```

## Plotting

vtebench contains a script for automatically plotting results using `gnuplot`.

To do this you first need to output the benchmark results in the `.dat` format:

```

cargo run --release -- --dat results.dat

```

After having generated the `.dat` file, you can then pass it to a script in the

`./gnuplot` directory to generate the SVG plot:

```

./gnuplot/summary.sh results.dat output.svg

```

You can combine any number of results by passing them to the gnuplot script:

```

./gnuplot/summary.sh *.dat output.svg

```

And can plot detailed results using `detailed.sh`:

```

./gnuplot/detailed.sh *.dat output/

```

## Contributing Benchmarks

If you have found benchmarks that might provide insightful information, or show

significant differences between different terminals and version, you can send a

pull request to add them to the default benchmark collection.

To do so, you just need to create a new directory in the `./benchmarks`

directory and add a `benchmark` and an optional `setup` executable. The stdout

of the benchmark will automatically be repeated to fill a reasonable minimum

sample size, so make sure to take that into account and move everything into

`setup` that should only be done once.