From 8d908b075486beac039a9090a1adfb71abb0d4f0 Mon Sep 17 00:00:00 2001 From: David Peter Date: Fri, 2 Oct 2026 11:55:37 +0200 Subject: [PATCH] Document the Python version required by the analysis scripts (#944) * Document the Python version required by the analysis scripts * Recommend uv for running the analysis scripts --- scripts/README.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/scripts/README.md b/scripts/README.md index e3e71e3..038a055 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -4,23 +4,14 @@ This folder contains scripts that can be used in combination with hyperfine's `- ```bash hyperfine 'sleep 0.020' 'sleep 0.021' 'sleep 0.022' --export-json sleep.json -./plot_whisker.py sleep.json +uv run plot_whisker.py sleep.json ``` ### Prerequisites -To make these scripts work, you will need `numpy`, `matplotlib` and `scipy`. +Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) and run the +commands above from this directory. -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 -``` +The scripts declare their dependencies using [PEP 723](https://peps.python.org/pep-0723/) +inline script metadata. `uv run` automatically installs these dependencies in an +isolated environment before running the script.