Bugtracker is a Python 3 package, as well as a set of command-line applications, which collectively provide a software suite for analyzing biological echoes from radar data.
This README contains the installation instructions and a quick start guide. A more in-depth user manual can be found in MANUAL.md
As of v1.5.0, Bugtracker is supported for the following operating systems:
We provide support for the following Radar filetypes:
git clone https://github.com/mcgillradar/bugtracker.git
Install miniconda3 Select the version marked "Python3.7 Miniconda3 Windows 64-bit" and run the installer.
Run the miniconda3 command line, and change directory into the bugtracker repository folder. Run the following commands to create and activate the environment:
conda env create --name bugtracker --file=environment_windows.yml
conda activate bugtracker
python rebuild.py
python generate_config.py
This command will prompt the user for a root directory to save application data.
cd tests
pytest
git clone https://github.com/mcgillradar/bugtracker.git
Install miniconda3 Select the version marked "Python3.7 Miniconda3 Linux 64-bit" and run the installer.
Open a terminal, and change directory into the bugtracker repository folder. Run the following commands to create and activate the environment:
conda env create --name bugtracker --file=environment_linux.yml
conda activate bugtracker
python rebuild.py
python generate_config.py
This command will prompt the user for a root directory to save application data.
cd tests
pytest
These instructions work for both Linux and Windows.
git pull
python rebuild.py
Apps are run from within the /apps folder.
Important: There are currently 4 command-line applications. To get help for each application, run the application with the '-h' flag. For example:
python nexrad_aws.py -h
This will display a help screen with information on what command-line arguments the application expects.
A quick way to get started would be the following:
cd /your/local/path/bugtracker/apps
# download 3 days worth of NEXRAD files for testing
python nexrad_aws.py 20190728 20190730 kcbw
# create calibration file (by default will run over a 6 hour period)
python calib.py 201907280300 nexrad kcbw
# run processing algorithm (by default will only do one timestamp, but can be extended)
python tracker.py 201907300300 nexrad kcbw