- Name: Duc Hoan Nguyen
You must write up README.md
for this repository to be eligable for readability marks.
- Students must keep all Jupyter Notebooks in the
notebooks
directory. - Students must keep all
.py
scripts under thescripts
directory. These can include helper functions and modules with relevant__init__.py
- Students must store all raw data downloaded (using a Python script) in the
data/raw
folder. This will be in the.gitignore
so do not upload any raw data files whatsoever. - Students must store all curated / transformed data in the
data/curated
folder. This will be in the.gitignore
so do not upload any raw data files whatsoever. We will be running your code from thescripts
directory to regenerated these. - All plots must be saved in the
plots
directory. - Finally, your report
.tex
files must be inside thereport
directory. If you are using overleaf, you can download the.zip
and extract it into this folder. - Add your name and Student ID to the fields above.
- Add your relevant
requirements.txt
to the root directory. If you are unsure, runpip3 list --format=freeze > requirements.txt
(or alternative) and copy the output to the repository. - You may delete all
.gitkeep
files if you really want to. These were used to ensure empty directories could be pushed togit
. - When you have read this, delete the
Student Instructions
section to clean the readme up.