Skip to content

Commit

Permalink
add: sigmf module doc
Browse files Browse the repository at this point in the history
  • Loading branch information
righel committed Aug 3, 2023
1 parent 1bbe16e commit e57c2af
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions documentation/website/expansion/sigmf-expand.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"description": "Enrichs a SigMF Recording or extracts a SigMF Archive into a SigMF Recording.",
"requirements": [
"matplotlib: For plotting the waterfall plot of the recording.",
"numpy: For the waterfall plot of the recording.",
"sigmf: For validating SigMF files."
],
"input": "Object of sigmf-archive or sigmf-recording template.",
"output": "Object of sigmf-expanded-recording or sigmf-recording template.",
"references": [
"https://github.com/sigmf/SigMF"
],
"features": "This module can be used to expand a SigMF Recording object into a SigMF Expanded Recording object with a waterfall plot or to extract a SigMF Archive object into a SigMF Recording objet."
}

0 comments on commit e57c2af

Please sign in to comment.