Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
smu160 committed Feb 3, 2024
1 parent 9faf970 commit 4a50376
Showing 1 changed file with 22 additions and 18 deletions.
40 changes: 22 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,33 +44,37 @@ FFT crates,
including [RustFFT](https://crates.io/crates/rustfft/), on both large and small inputs and while using significantly
less memory.

## Getting Started
## Quickstart

To integrate PhastFT into your Rust project:

...
### Rust

To use PhastFT with Python:
```rust
fn main() {
let N = 1 << 10;
let mut reals = vec![0.0; N];
let mut imags = vec![0.0; N];
gen_random_signal(&mut reals, &mut imags);

```bash
pip install ...
fft_dif(&mut reals, &mut imags);
}
```

...

## Examples

### Rust
### Python

PhastFT provides a straightforward API for performing FFT computations. Here's an example of using PhastFT for a basic
FFT
operation:
```bash
pip install numpy
pip install git+https://github.com/QuState/PhastFT#subdirectory=pybindings
```

...
```python
import numpy as np
from pybindings import fft

### Python
sig_re = np.asarray(sig_re, dtype=np.float64)
sig_im = np.asarray(sig_im, dtype=np.float64)

...
fft(a_re, a_im)
```

## Benchmarks

Expand Down

0 comments on commit 4a50376

Please sign in to comment.