There are guidelines on how code should be structured and uploaded to this repository.
pyrtlsdr is a the Python wrapper for librtlsdr (a driver for Realtek RTL2832U based SDR's) that we are using.
aprspy is an APRS packet parser for Python that we are using.
The first thing you should do prior to running your code is set up your virtual environment. To do this open you your terminal and make sure you are in the Payload-2022-2023
directory. Inside of that directory call the command
python3 -m venv env
to set up your virtual environment in a folder called env. Next you need to set this folder as your interpreter (your IDE might prompt you to do this automatically. If it did not prompt you, to do this in VS Code, press ctrl+shift+p
to open your command prompt and type in Python: Select Interpreter
. Press enter and select the one that ends in something like ('env':venv)
.
In order to install the required packages, open a new terminal in VS Code by pressing "ctrl+shift+`". This terminal will already be in your virtual environment, and simply run the command
pip install -r requirements.txt
In order to run pyrtlsdr, you will need to build librtlsfr. The instructions for building that can be found here.
Now that you have all the required packages installed, you can run the program by ... TODO: Write instructions on running the program.