This directory contains the Syncopy performance benchmarks, implemented with Airspeed Velocity, i.e., the asv Python package.

Note: The current version of asv does not seem to work with poetry at all, and it still defaults to using the rather outdated setup.py method instead of pyproject.toml. We do not hava a setup.py, nor do we want to ship one, so we convert our pyproject.toml to setup.py on the fly before running the performance benchmarks.

At the moment, asv does NOT support the pyproject.toml directly. To (re-)convert to setup.py do:

pip install dephell
dephell convert deps --from-path pyproject.toml --from-format pyproject --to-path setup.py --to-format setuppy

First change into the Syncopy repo. To run the benchmarks for the latest commit on your current branch:

poetry run asv machine --yes
poetry run asv run HEAD^!

If you are getting errors when running the benchmarks, e.g., no module named syncopy, you most likely have changed something with the asv configuration that broke the installation. In addition to fixing that, you will have to manually delete the old environments so that asv creates new ones afterwards:

rm -rf .asv/env

The benchmarks can be found in <repo>/benchmarks/benchmarks.py. See the asv docs for info on adding more.