README.md 5.26 KB
Newer Older
Martijn Vermaat's avatar
Martijn Vermaat committed
1
# Code and data management with Git
2

Martijn Vermaat's avatar
Martijn Vermaat committed
3
This is the website for the course *Code and data management with Git*. This
4 5 6
course consists of an introduction to working with the
[Git](http://git-scm.com/) version control system for data analysis and is
aimed primarily at researchers in the LUMC.
Martijn Vermaat's avatar
Martijn Vermaat committed
7

Martijn Vermaat's avatar
Martijn Vermaat committed
8 9 10 11
The Git system is widely used by software developers, but can also be used for
project management. In the LUMC we use [GitLab](https://git.lumc.nl) as a
collaborative environment on top of Git. By keeping track of all versions,
history, etc, GitLab makes your projects more reproducible and collaboration
Martijn Vermaat's avatar
Martijn Vermaat committed
12
with colleagues easy ([introduction](http://doc.gitlab.com/ce/gitlab-basics/README.html)).
Martijn Vermaat's avatar
Martijn Vermaat committed
13 14


Martijn Vermaat's avatar
Martijn Vermaat committed
15
## Coordinates
16

Mihai's avatar
Mihai committed
17
Details for the next session:
Mihai's avatar
Mihai committed
18
- Date: November 22nd, 2017
Mihai's avatar
Mihai committed
19 20
- Time: 9:30 - 16:30
- Location: TBA
21
- Teachers:
Mihai's avatar
Mihai committed
22
  - TBA
Mihai's avatar
Mihai committed
23
- Registration via www.medgencentre.nl. Direct access to the [registration form](https://forms.lumc.nl/lumc2/GITcourse).
Mihai's avatar
Mihai committed
24

25

Martijn Vermaat's avatar
Martijn Vermaat committed
26
## Program
27

28 29
| Time  | Subject                                                                                | Teacher           | Contents                  |
| ----- | -----------------                                                                      | ----------------- | ------------------------- |
30
| 10:00 | [Introduction](/uploads/c751916e71cc02c026491fad6c171a7d/introduction.pdf)             | Mihai Lefter      | Welcome, version control introduction |
Mihai's avatar
Mihai committed
31
| 10:30 | [Git basics](/uploads/5c35a9ecd72033b42ef55b602f6cb548/20170906_-_git-course_-_git-basics.pdf) | Wibowo Arindrarto | Basic Git command line flow |
Mihai's avatar
Mihai committed
32
| 11:15 | [Practical](/uploads/d56ee5edaeca415c5430b385750a89de/basics_handouts.pdf)             |                   |                           |
33
| 12:00 | Lunch                                                                                  |                   |                           |
Mihai's avatar
Mihai committed
34 35
| 13:00 | [Collaboration: remote repositories](/uploads/a189f6a373afac0509d96812d7a2b49a/remotes.pdf)   | Jonathan Vis   | Sharing and collaborating via remotes |
| 13:45 | [Practical](/uploads/286d7abb800c6f3f1540a49a6aefd25b/remotes_handouts.pdf)             |                   |                           |
36
| 14:15 | Break                                                                                  |                   |                           |
37 38
| 14:30 | [Collaboration: combining changes by merging](/uploads/daec1d922f0bfe036adfea260dba26b0/merging.pdf)  | Mihai Lefter   | Commit graph, merging, resolving merge conflicts |
| 15:15 | [Practical](/uploads/d8fb514d9181aed85ff2843ce80ec4d0/merging_handouts.pdf)            |                   |                           |
39
| 15:45 | Break                                                                                  |                   |                           |
40 41
| 16:00 | [Extras](/uploads/6421469e8b44778f7c57958ba5f36171/extras.pdf)  | Mihai Lefter   | GitLab and Markdown. |
| 16:30 | [Practical](/uploads/3cde4b0450bf749bb5b9a7954adb8f33/extras_handouts.pdf)            |                   |                           |
42
| 17:00 | Questions, closing                                                                     |                   |                           |
43 44 45 46 47 48


## Prerequisites

Affinity with the UNIX shell is required before taking the course. For
example, our
Mihai's avatar
Mihai committed
49
[Practical Linux Course](https://git.lumc.nl/courses/practical-linux-course)
Mihai's avatar
Mihai committed
50
is more than enough. In addition, you can find some nice 
Mihai's avatar
Mihai committed
51
[tutorials here](http://www.ee.surrey.ac.uk/Teaching/Unix/).
52 53 54

We encourage you to bring your own laptop, but make sure it has a terminal and
[Git](http://git-scm.com/) installed. We work with
Martijn Vermaat's avatar
Martijn Vermaat committed
55 56
[Linux](http://en.wikipedia.org/wiki/Linux), but Git also runs on Mac OSX.
Windows is not ideal, but here are [some suggestions](WINDOWS.md).
57 58 59 60 61 62 63 64

We can also provide you with a laptop that has all the required software
installed. The lessons are interactive, meaning that you really need a
laptop.


## Further reading

Martijn Vermaat's avatar
Martijn Vermaat committed
65
- [Code School - Try Git](https://try.github.io/) (you could even try this
66
  before the course)
Martijn Vermaat's avatar
Martijn Vermaat committed
67 68 69
- [The entire Pro Git book](http://git-scm.com/book) on the official [Git
  website](http://git-scm.com/)
- [Ry's Git Tutorial](http://rypress.com/tutorials/git/index.html)
Mihai's avatar
Mihai committed
70
- [Git tutorials at Atlassian](https://www.atlassian.com/git/tutorials)
Martijn Vermaat's avatar
Martijn Vermaat committed
71 72
- [Learn Git Branching](http://pcottle.github.io/learnGitBranching/)
- [Git cheat sheet](https://git.wiki.kernel.org/index.php/GitCheatSheet)
73 74 75 76
  (useful for printing)


## Past course dates
Martijn Vermaat's avatar
Martijn Vermaat committed
77

Mihai's avatar
Mihai committed
78
- September 6th, 2017: Code and data management with Git
Martijn Vermaat's avatar
Martijn Vermaat committed
79 80
- October 14th, 2013: Git introduction course
- June 23rd, 2014: Git introduction course
81
- December 1st, 2015: Code and data management with Git
82
- April 25th, 2016: Code and data management with Git
Martijn Vermaat's avatar
Martijn Vermaat committed
83

Martijn Vermaat's avatar
Martijn Vermaat committed
84
For corresponding snapshots of this repository, see [tags](https://git.lumc.nl/humgen/gitcourse/tags).
Martijn Vermaat's avatar
Martijn Vermaat committed
85 86


Martijn Vermaat's avatar
Martijn Vermaat committed
87
## Using the course materials
Martijn Vermaat's avatar
Martijn Vermaat committed
88

Martijn Vermaat's avatar
Martijn Vermaat committed
89 90 91 92 93 94 95 96 97 98
There is one [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
on which this repository depends:

- **[presentation](https://git.lumc.nl/j.f.j.laros/presentation)** template for
  presentations in LaTeX.

First clone this repository, then fetch the data from the submodule:

    git clone https://git.lumc.nl/humgen/gitcourse.git
    cd gitcourse
Martijn Vermaat's avatar
Martijn Vermaat committed
99 100 101 102 103 104
    git submodule init
    git submodule update

A new presentation can be added like this:

    cd presentation
105
    bash mkpres.sh ../mypresentation