README.md 2.65 KB
Newer Older
Paul McCarthy's avatar
Paul McCarthy committed
1
# 2020 WIN PyTreat
Paul McCarthy's avatar
readme  
Paul McCarthy committed
2
3


Paul McCarthy's avatar
Paul McCarthy committed
4
This repository contains Jupyter notebooks and data for the 2020 WIN PyTreat.
Paul McCarthy's avatar
Paul McCarthy committed
5
6
7
8
It contains the following:

- The `talks` directory contains some (but not all) of the _Topyc_ talks that
  will be given throughout the week.
9
10
11
12
13
14
15
16
17
18
19

- The `getting_started` directory contains a series of practicals intended
  for those of you who are new to the Python programming language, or need
  a refresher.

- The `advanced_topics` directory contains a series of practicals on various
  aspects of the Python programming language - these are intended for those
  of you who are familiar with the basics of Python, and want to learn more
  about the language.


Paul McCarthy's avatar
Paul McCarthy committed
20
The practicals have been written under the assumption that FSL 6.0.3 is
21
22
23
24
25
26
installed.


## For attendees


27
These notebooks can be run in the `fslpython` environment using:
28
29
30
31
32


```
git clone git@git.fmrib.ox.ac.uk:fsl/pytreat-2018-practicals.git
cd pytreat-2018-practicals
33
fslpython -m notebook
34
35
36
```


Paul McCarthy's avatar
Paul McCarthy committed
37
38
39
40
41
42
Throughout the week we might make changes to this repository. When this
happens, we will ask you to update your local clone of the repository with the
following command:


```
Paul McCarthy's avatar
Paul McCarthy committed
43
git stash save
Paul McCarthy's avatar
Paul McCarthy committed
44
git pull origin master
Paul McCarthy's avatar
Paul McCarthy committed
45
git stash pop
Paul McCarthy's avatar
Paul McCarthy committed
46
47
48
```


49
50
51
52
Have fun!


## For contributors
Paul McCarthy's avatar
readme  
Paul McCarthy committed
53
54


Paul McCarthy's avatar
Paul McCarthy committed
55
The upstream repository can be found at:
Paul McCarthy's avatar
Paul McCarthy committed
56
57

https://git.fmrib.ox.ac.uk/fsl/pytreat-2018-practicals
Paul McCarthy's avatar
readme  
Paul McCarthy committed
58
59
60
61


To contribute to the practicals:

Paul McCarthy's avatar
Paul McCarthy committed
62
1. Fork the upstream repository on gitlab
Paul McCarthy's avatar
readme  
Paul McCarthy committed
63

Paul McCarthy's avatar
Paul McCarthy committed
64
2. Make a local clone of your fork:
Paul McCarthy's avatar
readme  
Paul McCarthy committed
65

Paul McCarthy's avatar
Paul McCarthy committed
66
67
68
    ```
    git clone git@git.fmrib.ox.ac.uk:<username>/pytreat-2018-practicals
    ```
Paul McCarthy's avatar
Paul McCarthy committed
69
70
71

3. Add the upstream repository as a remote:

Paul McCarthy's avatar
Paul McCarthy committed
72
73
74
    ```
    git remote add upstream git@git.fmrib.ox.ac.uk:fsl/pytreat-2018-practicals.git
    ```
Paul McCarthy's avatar
Paul McCarthy committed
75
76
77
78
79

4. Make your changes on your local repository

5. Rebase onto the upstream repository, and push your changes to your fork:

Paul McCarthy's avatar
Paul McCarthy committed
80
81
    ```
    git fetch --all
Paul McCarthy's avatar
Paul McCarthy committed
82
83
    git rebase upstream/master
    git push --force origin master
Paul McCarthy's avatar
Paul McCarthy committed
84
    ```
Paul McCarthy's avatar
Paul McCarthy committed
85
86
87

6. In gitlab, submit a merge request from your fork back to the upstream
   repository.
Paul McCarthy's avatar
Paul McCarthy committed
88
89


90
You may also wish to install
91
[`notedown`](https://github.com/aaren/notedown):
Paul McCarthy's avatar
Paul McCarthy committed
92

Paul McCarthy's avatar
Paul McCarthy committed
93
```
94
source $FSLDIR/fslpython/bin/activate fslpython
Paul McCarthy's avatar
Paul McCarthy committed
95
96
pip install notedown
source deactivate
97
fslpython -m notedown
Paul McCarthy's avatar
Paul McCarthy committed
98
99
100
ln -s $FSLDIR/fslpython/envs/fslpython/bin/notedown $FSLDIR/bin/fslnotedown
```

101
102
103
104
105
`notedown` is a handy tool which allows you to convert a markdown (`.md`) file
to a Jupyter notebook (`.ipynb`) file. So you can write your practical in your
text editor of choice, and then convert it into a notebook, instead of writing
the practical in the web browser interface. If you install notedown as
suggested in the code block above, you can run it on a markdown file like so:
Paul McCarthy's avatar
Paul McCarthy committed
106
107
108


```
109
fslnotedown my_markdown_file.md > my_notebook.ipynb
Paul McCarthy's avatar
Paul McCarthy committed
110
```