/ds-bsgi-support

Support for the Black Sea Grain Initiative

GNU General Public License v3.0GPL-3.0

Black Sea Grain Initiative Support

About

Support for the Black Sea Grain Initiative monitoring.

Reproducing this analysis

Create a directory where you would like the data to be stored, and point to it using an environment variable called AA_DATA_DIR.

Next create a new virtual environment and install the requirements with:

pip install -r requirements.txt

Finally, install any code in src using the command:

pip install -e .

Development

All code is formatted according to black and flake8 guidelines. The repo is set-up to use pre-commit. Before you start developing in this repository, you will need to run

pre-commit install

The markdownlint hook will require Ruby to be installed on your computer.

You can run all hooks against all your files using

pre-commit run --all-files

It is also strongly recommended to use jupytext to convert all Jupyter notebooks (.ipynb) to Markdown files (.md) before committing them into version control. This will make for cleaner diffs (and thus easier code reviews) and will ensure that cell outputs aren't committed to the repo (which might be problematic if working with sensitive data).