Recommend uv for running the analysis scripts

This commit is contained in:
David Peter committed 2026-10-02 11:52:44 +02:00
1 parent 352c504d3f
commit 9cc442567a
1 file changed
+6 -16
+6 -16
View File
@@ -4,24 +4,14 @@ 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
./plot_whisker.py sleep.json
uv run plot_whisker.py sleep.json
```
### Pre-requisites
To make these scripts work, you will need Python 3.10 or newer and the packages
`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
python3 -m pip install numpy matplotlib scipy
```
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.