Update docu

This commit is contained in:
David Peter 2024-08-28 17:25:05 +02:00 committed by David Peter
parent 9e265bd99b
commit 5c716e48c8

View File

@ -4,13 +4,22 @@ This folder contains scripts that can be used in combination with hyperfines `--
```bash
hyperfine 'sleep 0.020' 'sleep 0.021' 'sleep 0.022' --export-json sleep.json
python plot_whisker.py sleep.json
./plot_whisker.py sleep.json
```
### Pre-requisites
To make these scripts work, you will need to install `numpy`, `matplotlib` and `scipy`. Install them via
your package manager or `pip`:
To make these scripts work, you will need to install `numpy`, `matplotlib` and `scipy`.
If you have a Python package manager that understands [PEP-723](https://peps.python.org/pep-0723/)
inline script requirements like [`uv`](https://github.com/astral-sh/uv) or [`pipx`](https://github.com/pypa/pipx),
you can directly run the scripts using
```bash
uv run plot_whisker.py sleep.json
```
Otherwise, install the dependencies via your system package manager or using `pip`:
```bash
pip install numpy matplotlib scipy # pip3, if you are using python3