Metadata-Version: 2.4
Name: pyspecan
Version: 0.5.2
Summary: A spectrum analyzer library
Author-email: Anonoei <to+dev@an0.us>
Project-URL: Homepage, https://github.com/anonoei/pyspecan
Project-URL: Documentation, https://anonoei.github.io/pyspecan/
Project-URL: Repository, https://github.com/Anonoei/pyspecan.git
Project-URL: Issues, https://github.com/Anonoei/pyspecan/issues
Project-URL: Source, https://github.com/anonoei/pyspecan
Keywords: anonoei,sdr,speca,specan
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pysdrlib
Provides-Extra: dev
Requires-Dist: twine; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: bumpver; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pdoc3; extra == "dev"
Dynamic: license-file

# pyspecan
 A spectrum analyzer library

 - [Documentation](https://anonoei.github.io/pyspecan/)
 - [PyPI](https://pypi.org/project/pyspecan/)


# Examples
tkGUI, SWEPT mode
![tkGUI_Swept](/media/SWEPT_tkGUI.png)
![tkGUI_Swept](/media/SWEPT_tkGUI2.png)

tkGUI, RT mode
![tkGUI_RT](/media/RT_tkGUI.png)
![tkGUI_RT](/media/RT_tkGUI2.png)

# Usage
- View (-v|--view): specifies which frontend to use (tkGUI)
- Mode (-m|--mode): specifies which processing mode to use (swept, rt)
- Sink (-s|--sink): specifies which interface to use (file, live)
  - Live uses [pysdrlib](https://github.com/anonoei/pysdrlib) for hardware SDR abstractions

## Module
- `python3 -m pyspecan --help`
- tkGUI, swept, file: `python3 -m pyspecan`
- tkGUI, RT, file: `python3 -m pyspecan -m RT`
- tkGUI, swept, live (hackrf): `python3 -m pyspecan -s live -d hackrf`

# Install
1. Run `pip install pyspecan`, to install
2. Run `python3 -m pyspecan --help` to view available arguments

# Contributing
1. `git clone https://github.com/Anonoei/pyspecan`
2. `cd pyspecan`
3. `git branch -c feature/<your feature>`
4. `python3 builder.py -b -l` build and install locally

## Build executable
1. `pyinstaller src/pyspecan.spec`
2. `./dist/pyspecan`
