This document provides installation instructions, for usage instructions see tutorial.
RAPIDKRILL requires Python 3.6. Follow installation instructions for Linux, Mac OS, or Windows, if you have not installed yet.
The recommended means of installation is by cloning the git repository. If you don't already have git installed, follow the instructions here.
By convention, we keep code in a src directory:
# Linux & Mac OS:
mkdir ~/src
cd ~/src
git clone https://github.com/bas-acoustics/rapidkrill.git
# Windows:
mkdir C:\src
cd C:\src
git clone https://github.com/bas-acoustics/rapidkrill.git
The RAPIDKRILL dependencies are listed in requirements.txt and includes the following packages:
- matplotlib for plotting echograms.
- numpy for large, multi-dimensional arrays.
- pandas for data analysis.
- geopy python geocoding toolbox.
- PyEcholab for reading echosounder files.
- scipy for scientific computing.
- toml for configuration files.
- sendgrid for sending email.
- opencv-python for image processing.
- scikit-image for image processing.
- EchoPy
The dependencies can be installed in a number of different ways depending on your system and preferences. For example, using pip command:
# Linux & Mac OS
cd ~/src/rapidkrill
pip install -r requirements.txt
# Windows
cd C:\src\rapidkrill
pip install -r requirements.txt
If you haven't installed pip yet. Follow these instructions.