Add a minimal README

parent c11a22f3
# KDTree implementations comparison
This compares several implementations of `KDTree` against one made using Cython+.
## Reproducing benchmarks on GNU/Linux
> ⚠ Currently this project `make` targets have been written for GNU/Linux as it makes
> uses of `taskset(1)` to set CPU affinity. You define CPU affinity under others OS
> easily using the `OMP_NUM_THREADS` environment variable.
You need to have [`conda`]( installed on your system.
Then simply clone the repository and `make`:
git clone
cd kdtree
PDF reports will be written in a subfolder in `results` whose names match: `<commit-hash>_analysis`
## Running tests
conda activate kdtree
pip install pytest
pytest tests
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment