mirror of
https://github.com/sharkdp/hyperfine.git
synced 2026-10-28 08:08:58 +00:00
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
This commit is contained in:
1 parent
d75c16d39c
commit
8d908b0754
1 file changed
+6
-15
+6
-15
@@ -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.
|
||||
Reference in new issue
Block a user