marcusinthesky/Zindi-ZA-COVID19-Vulnerablity-Map

An entry in the South African COVID-19 Vulnerability Map by #ZindiWeekendz. # Zindi ZA COVID19 Vulnerabulity Map ## Overview This is your new Kedro project, which was generated using `Kedro 0.15.8` by running: ``` kedro new ``` Take a look at the documentation to get started. ## Rules and guidelines In order to get the best out of the template: * Please don't remove any lines from the `.gitignore` file provided * Make sure your results can be reproduced by following a data engineering convention, e.g. the one we suggest here * Don't commit any data to your repository * Don't commit any credentials or local configuration to your repository * Keep all credentials or local configuration in `conf/local/` ## Installing dependencies Dependencies should be declared in `src/requirements.txt` for pip installation and `src/environment.yml` for conda installation. To install them, run: ``` kedro install ``` ## Running Kedro You can run your Kedro project with: ``` kedro run ``` ## Testing Kedro Have a look at the file `src/tests/test_run.py` for instructions on how to write your tests. You can run your tests with the following command: ``` kedro test ``` To configure the coverage threshold, please have a look at the file `.coveragerc`. ### Working with Kedro from notebooks In order to use notebooks in your Kedro project, you need to install Jupyter: ``` pip install jupyter ``` For using Jupyter Lab, you need to install it: ``` pip install jupyterlab ``` After installing Jupyter, you can start a local notebook server: ``` kedro jupyter notebook ``` You can also start Jupyter Lab: ``` kedro jupyter lab ``` And if you want to run an IPython session: ``` kedro ipython ``` Running Jupyter or IPython this way provides the following variables in scope: `proj_dir`, `proj_name`, `conf`, `io`, `parameters` and `startup_error`. #### Converting notebook cells to nodes in a Kedro project Once you are happy with a notebook, you may want to move your code over into the Kedro project structure for the next stage in your development. Th …