Download benthic image data from SQUIDLE.
You can download the repository from GitHub with:
git clone [email protected]:DalhousieAI/squidle-downloader.git
Install it in editable mode with:
pip install -e .
This repository uses the black code style, and numpy docstring format (example). Your code should also be flake8 compliant.
So that you don't have to manually modify code to fit the style guide, we have a git hook using pre-commit. This will execute every time you make a commit, and will blacken your code before it is committed. It will also check for common code errors.
To set up the pre-commit hook, run the following code:
pip install -r requirements-dev.txt pre-commit install
Whenever you try to commit code which needs to be modified by the commit hook, you'll have to add the commit hooks changes and then redo your commit.
You can also manually run the pre-commit stack on all the files at any time:
pre-commit run --all-files