Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc updates for gamutrf-offline #1044

Merged
merged 1 commit into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/4-OPERATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,14 @@ until a new RPC (whether rssi or record) is received.

Below are some untility functions for working with GamutRF and the collected IQ files.

### Running GamutRF pipeline from IQ file

gamutrf-offline can be used to run a previously recorded IQ file through GamutRF to simulate expected behavior of FFT, spectrogram generation, and model performance. To run in offline mode you will need to supply the relevant IQ file as either .sigmf-data file and the relevant .sigmf-meta file or the .zst or raw IQ file with the appropriately formatted naming convention.

```bash
docker run -v $(pwd):/gamutrf/data -ti iqtlabs/gamutrf gamutrf-offline --tune-step-fft=512 --db_clamp_floor=-150 --fft_batch_size=256 --nfft=1024 "data/{source_file}.sigmf-meta"
```

### Working with worker I/Q recordings

Workers make recordings that are compressed with zstandard, and are typically in complex number, int16 format, and include the center frequency and sample rate that the recording was made with. gamutRF tools can generally work with such files directly, but other tools require the recordings to be converted (see below).
Expand Down
Empty file added docs/8-DEVELOPMENT.md
Empty file.
Loading