Github-Training-Repository

This repository is meant to be used to train new hires/volunteers on how to use Github.

Preparation Material

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

Exercise

1. Fork this repository
2. Clone it to your local computer
3. Recreate the folder structure as described in the ALLFED Guidelines
4. Create a local virtual environment for the repository
5. Create two files in the src folder: numerical.py and plotting.py
6. Write a function in numerical.py that takes at least one argument and returns a numerical value
7. Write a function in plotting.py that creates a scatter plot and uses the ALLFED Style Sheet
8. Make your repository an installable package as described in Good Research Code Handbook
9. Add a Jupyter Notebook in your scripts folder and import numerical.py and call it
10. Write two tests for numerical.py
11. Make sure that the documenation of all code follows the ALLFED Guidelines
12. Automate the tests, so they run on every commit (you can just copy the files needed for that from the template
13. Create an environment.yml that specifies how your virtual environment can be recreated and save it in the repository
14. Send back a pull request
15. Invite one of the data scientist (either florian@allfed.info or morgan@allfed.info) to review your pull request

If you get stuck at any point please reach out to one of the data scientists (either florian@allfed.info or morgan@allfed.info).