ELIXIR Lesson Title
Authors
Greek Mythology icons made by max.icons from www.flaticon.com
Lesson overview
Description
Version control is the lab notebook of the digital world. It helps us understand what changes we made in the past and why we did a specific analysis in the way we did it. It is also vital for smooth collaboration where different people work on the same code simultaneously. Using version control for your research project means that your work is totally transparent, and because all your actions are recorded, it enables others to reproduce your studies.
In this series, we will cover the basics of using Git with the GUI provided in PyCharm. Git is a open source, free of charge, and powerful version control tool, and we will demonstrate the few simple steps to boost your code organisation and reproducibility, all without the need of command line knowledge. We will then use GitHub to host and share our scripts, and show hands-on examples of how GitHub can facilitate code collaboration.
Prerequisites
To be able to follow this course, learners should have knowledge in:
1. No previous knowledge of Git assumed
2. Able to understand and write simple Python scripts
Learning Outcomes:
By the end of the course, learners will be able to:
1. Understand the purpose and functionality of version control tools (e.g. Git)
2. Know how to create and use a local repository with Git UI in PyCharm
3. Know how to collaborate on a remote repository on GitHub
Target Audience: Researchers, undergraduate students, postgraduate students, etc…
Level: Beginner
License: Creative Commons Attribution 4.0 International License
Funding: This project has received funding from [name of funders].
Contributors
Kim Martin
Citing this lesson
Please cite as:
- Enter your citation here.
- Geert van Geest, Elin Kronander, Jose Alejandro Romero Herrera, Nadja Žlender, & Alexia Cardona. (2023). The ELIXIR Training Lesson Template - Developing Training Together (v1.0.0-alpha). Zenodo. https://doi.org/10.5281/zenodo.7913092.
Setup
Software setup
To run this course you need to install Git. Details for Git setup is described in Chapter 3.
We also introduce how to use Git with a GUI (GitHub Desktop as an example) / IDE (PyCharm as an example).