Welcome to pyquickbench’s documentation!#

Pyquickbench is an open source, easy to use benchmarking tool written in pure Python.

Main features#

  • Timings / repeatability / output benchmarks

  • Error handling

  • Benchmark results caching

  • Multithreaded / multiprocessed benchmarks

  • Benchmark timeout

  • Multidimensional benchmarks

  • Transformed data plotting (relative values, convergence order, …)

  • Intelligent plots

  • Sensible defaults

Usage#

Checkout the Gallery to get an idea of what pyquickbench is capable.

Install#

Pyquickbench is available on conda-forge. To install using conda, simply type:

conda install pyquickbench -c conda-forge

Pyquickbench is available on the Python Package Index. To install using pip, simply type:

pip install pyquickbench

To install the current development version of pyquickbench from the github repository, you can type:

pip install git+ssh://git@github.com/gabrielfougeron/pyquickbench.git

Tests#

To run tests locally on your machine, first checkout this reposity and install dependencies using pip:

git clone git@github.com:gabrielfougeron/pyquickbench.git
cd pyquickbench
pip install .[tests]

Then, run tests using pytest

pytest