README.md 5.27 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
In 2017 the course will be given on the following dates: 
18
6 September (10:00 - 17:00), 22 November (9:30 - 16:30). 
Mihai's avatar
Mihai committed
19 20

Details for the next session:
21
- Date: September 6th, 2017
22
- Time: 10:00 - 17:00
23
- Location: 01-J-01-084
24
- Teachers:
25 26 27
  - Wibowo Arindrarto
  - Jonathan Vis
  - Mihai Lefter
Mihai's avatar
Mihai committed
28
- Registration via www.medgencentre.nl. Direct access to the [registration form](https://forms.lumc.nl/lumc2/GITcourse).
Mihai's avatar
Mihai committed
29

30

Martijn Vermaat's avatar
Martijn Vermaat committed
31
## Program
32

33 34
| Time  | Subject                                                                                | Teacher           | Contents                  |
| ----- | -----------------                                                                      | ----------------- | ------------------------- |
Mihai's avatar
Mihai committed
35
| 10:00 | [Introduction](/uploads/ccbce60d8d17dd5e9d7949d91cc20a57/introduction.pdf)             | Mihai Lefter      | Welcome, version control introduction |
36 37
| 10:30 | [Git basics](http:bit.ly/1WlfXyj)                                                      | Wibowo Arindrarto | Basic Git command line flow |
| 11:15 | [Practical](/uploads/eb2e001db4f605a343e19d23d40e754f/basics_handouts.pdf)             |                   |                           |
38
| 12:00 | Lunch                                                                                  |                   |                           |
39 40 41
| 13:00 | [Collaboration: remote repositories](/uploads/e1239f626e6c32a6c0bd915a0dc716ad/remotes.pdf)   | Jonathan Vis   | Sharing and collaborating via remotes |
| 13:45 | [Practical](/uploads/dff8ad1b0f947d5866acdcdc70f3d673/remotes_handouts.pdf)             |                   |                           |
| 14:15 | Break                                                                                  |                   |                           |
Mihai's avatar
Mihai committed
42
| 14:30 | [Collaboration: combining changes by merging](/uploads/1bc6dc39f8c0234264b3efbbd596ccbe/merging.pdf)  | Mihai Lefter   | Commit graph, merging, resolving merge conflicts |
43 44 45 46 47
| 15:15 | [Practical](/uploads/9455ef406dfeb0e3c365c015965cd899/merging_handouts.pdf)            |                   |                           |
| 15:45 | Break                                                                                  |                   |                           |
| 16:00 | [Extras]()  | Mihai Lefter   | GitLab, GitHub, Markdown, ... |
| 16:30 | [Practical]()            |                   |                           |
| 17:00 | Questions, closing                                                                     |                   |                           |
48 49 50 51 52 53


## Prerequisites

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

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
60 61
[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).
62 63 64 65 66 67 68 69

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
70
- [Code School - Try Git](https://try.github.io/) (you could even try this
71
  before the course)
Martijn Vermaat's avatar
Martijn Vermaat committed
72 73 74
- [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
75
- [Git tutorials at Atlassian](https://www.atlassian.com/git/tutorials)
Martijn Vermaat's avatar
Martijn Vermaat committed
76 77
- [Learn Git Branching](http://pcottle.github.io/learnGitBranching/)
- [Git cheat sheet](https://git.wiki.kernel.org/index.php/GitCheatSheet)
78 79 80 81
  (useful for printing)


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

Martijn Vermaat's avatar
Martijn Vermaat committed
83 84
- October 14th, 2013: Git introduction course
- June 23rd, 2014: Git introduction course
85
- December 1st, 2015: Code and data management with Git
86
- April 25th, 2016: Code and data management with Git
Martijn Vermaat's avatar
Martijn Vermaat committed
87

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


Martijn Vermaat's avatar
Martijn Vermaat committed
91
## Using the course materials
Martijn Vermaat's avatar
Martijn Vermaat committed
92

Martijn Vermaat's avatar
Martijn Vermaat committed
93 94 95 96 97 98 99 100 101 102
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
103 104 105 106 107 108
    git submodule init
    git submodule update

A new presentation can be added like this:

    cd presentation
109
    bash mkpres.sh ../mypresentation