Updated benchmark instructions and fixed typos

.gitignore

@@ -177,3 +177,9 @@ cython_debug/
 
 # macOS
 .DS_Store
+
+# Benchmarks outputs
+benches/benchmark-data.*
+benches/*benchmarks_bar_plot*.png
+benches/__pycache__
+benches/elapsed_times.csv

README.md

@@ -79,12 +79,12 @@ Then you can install PhastFT itself:
 
 ```bash
 pip install numpy
-RUSTFLAGS='-Ctarget-cpu=native' pip install git+https://github.com/QuState/PhastFT#subdirectory=pybindings
+RUSTFLAGS='-Ctarget-cpu=native' pip install git+https://github.com/QuState/PhastFT#subdirectory=pyphastft
 ```
 
 ```python
 import numpy as np
-from pybindings import fft
+from pyphastft import fft
 
 sig_re = np.asarray(sig_re, dtype=np.float64)
 sig_im = np.asarray(sig_im, dtype=np.float64)

benches/README.md

@@ -4,7 +4,7 @@
 
 ### Setup Environment
 
-1. Install [FFTW3](http://www.fftw.org/download.html)
+1. Install [FFTW3](http://www.fftw.org/download.html)[^1]
 
    It may be possible to install `fftw3` using a package manager.
 
@@ -13,19 +13,19 @@
    sudo apt install libfftw3-dev
    ```
 
-2. Clone the `PhastFT` git repository [^1].
+2. Clone the `PhastFT` git repository [^2].
 
 3. Create virtual env
 
 ```bash
 cd ~/PhastFT/benches && python -m venv .env && source .env/bin/activate
 ```
 
-4. Install python dependencies
+4. Install python dependencies[^1]
 
 ```bash
 pip install -r requirements.txt
-cd ~/PhastFT/pybindings
+cd ~/PhastFT/pyphastft
 RUSTFLAGS='-Ctarget-cpu=native' pip install .
 ```
 
@@ -113,4 +113,6 @@ Finally, run:
 ./profile.sh
 ```
 
-[^1]: This tutorial assumes you will clone `PhastFT` to `$HOME`
+[^1]: Those with macOS on Apple Silicon should consult [pyFFTW Issue #352](https://github.com/pyFFTW/pyFFTW/issues/352#issuecomment-1945444558)
+
+[^2]: This tutorial assumes you will clone `PhastFT` to `$HOME`

benches/py_benchmarks.py

@@ -8,7 +8,7 @@
 
 pyfftw.interfaces.cache.enable()
 
-from pybindings import fft
+from pyphastft import fft
 
 from utils import bytes2human