From 5c716e48c82cf53b9415226810ba0bb127772a17 Mon Sep 17 00:00:00 2001 From: David Peter Date: Wed, 28 Aug 2024 17:25:05 +0200 Subject: [PATCH] Update docu --- scripts/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/scripts/README.md b/scripts/README.md index dfb47a7..8d77d06 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -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