This repository is meant to be used to train new hires/volunteers on how to use Github.
Please read/watch all those materials before you start the exercise.
- Getting started with anaconda and conda
- Good Research Code Handbook
- How to use Github with Github Desktop
- ALLFED Repository Template Readme
- Overview of Python
- Automated Testing
- The OpenAI Chat Bot is pretty good at answering programming questions
- Fork this repository
- Clone it to your local computer
- Recreate the folder structure as described in the ALLFED Guidelines
- Create a local virtual environment for the repository
- Create two files in the src folder: numerical.py and plotting.py
- Write a function in numerical.py that takes at least one argument and returns a numerical value
- Write a function in plotting.py that creates a scatter plot and uses the ALLFED Style Sheet
- Make your repository an installable package as described in Good Research Code Handbook
- Add a Jupyter Notebook in your scripts folder and import numerical.py and call it
- Write two tests for numerical.py
- Make sure that the documenation of all code follows the ALLFED Guidelines
- Automate the tests, so they run on every commit (you can just copy the files needed for that from the template
- Create an environment.yml that specifies how your virtual environment can be recreated and save it in the repository
- Send back a pull request
- Invite one of the data scientist (either [email protected] or [email protected]) to review your pull request
If you get stuck at any point please reach out to one of the data scientists (either [email protected] or [email protected]).