From 6f7e28102532ff7410ab93802e0b35a2e967fbae Mon Sep 17 00:00:00 2001 From: Chris Langfield <34426450+chris-langfield@users.noreply.github.com> Date: Tue, 21 May 2024 11:28:33 -0400 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0c6d0e..f7f11ec 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,24 @@ A Python package aiming to provide an easy and efficient interface to various implementations of the [Hexagonal Fast Fourier Transform](https://en.wikipedia.org/wiki/Hexagonal_fast_Fourier_transform). +### Install + +``` +pip install hexfft +``` + +The only dependencies are `numpy`, `scipy`, and `matplotlib`. `pytest` is required to run the tests. + +#### Developer install + +``` +git clone git@github.com:chris-langfield/hexfft.git +pip install -e hexfft/ +cd hexfft +pytest tests/ +``` --------------------------------------- > R. M. Mersereau, "The processing of hexagonally sampled two-dimensional signals," in Proceedings of the IEEE, vol. 67, no. 6, pp. 930-949, June 1979, doi: 10.1109/PROC.1979.11356 -> Ehrhardt, J. C. (1993). Hexagonal fast Fourier transform with rectangular output. In IEEE Transactions on Signal Processing (Vol. 41, Issue 3, pp. 1469–1472). Institute of Electrical and Electronics Engineers (IEEE). https://doi.org/10.1109/78.205759 \ No newline at end of file +> Ehrhardt, J. C. (1993). Hexagonal fast Fourier transform with rectangular output. In IEEE Transactions on Signal Processing (Vol. 41, Issue 3, pp. 1469–1472). Institute of Electrical and Electronics Engineers (IEEE). https://doi.org/10.1109/78.205759