Merge pull request #1044 from lk-iqt/offline-doc-update

Doc updates for gamutrf-offline
IQTLabs · Dec 15, 2023 · a4ec5df · a4ec5df
2 parents 8a97e99 + 79396fe
commit a4ec5df
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/4-OPERATION.md b/docs/4-OPERATION.md
@@ -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).

diff --git a/docs/8-DEVELOPMENT.md b/docs/8-DEVELOPMENT.md