(benchmarks)=

# Benchmarks

ContourPy uses `asv` ([airspeed velocity](https://asv.readthedocs.io>)) for benchmarking.

To run the entire benchmarking suite:

```bash
$ pip install asv virtualenv
$ cd benchmarks
$ asv run
```

This will benchmark the latest commit of the `main` branch. When this is finished you can display
the results in a web browser using:

```bash
$ asv publish
$ asv preview
```

For further information see the `README.md` document in the `benchmarks` directory.

There follows a summary of key benchmark results taken on a 6-core Intel Core i7-10750H processor
using Python 3.12.3 and g++ 13.2.0 on Ubuntu 24.04 for commit `3064ab24`.

```{toctree}
:maxdepth: 1

calculation
rendering
chunks
threads
```

```{note}
If you want to reproduce these plots for your own hardware, run the benchmarks locally as
described above and then run the `plot_benchmarks.py` script to extract the benchmark results
and generate the plots.  Some tweaking of plot parameters may be required to get them looking
nice.
```