README.md 3.57 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
git clone https://git.fmrib.ox.ac.uk/fsl/pytreat-practicals-2020.git
Paul McCarthy's avatar
Paul McCarthy committed
32
cd pytreat-practicals-2020
33
fslpython -m notebook
34
35
```

36
37
38
39
40
41
42
A page should open in your web browser - to access the practicals, navigate
into one of the `getting_started` or `advanced_topics` directories, and click
on the `.ipynb` file you are interested in. Some of the talks are also
presented in notebook form - navigate to the talk you are interested in
(within the `talks` directory), and click on the `.ipynb` file to follow
along.

43

Paul McCarthy's avatar
Paul McCarthy committed
44
45
46
47
48
49
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
50
git stash save
Paul McCarthy's avatar
Paul McCarthy committed
51
git pull origin master
Paul McCarthy's avatar
Paul McCarthy committed
52
git stash pop
Paul McCarthy's avatar
Paul McCarthy committed
53
54
55
```


56
57
58
59
Have fun!


## For contributors
Paul McCarthy's avatar
readme  
Paul McCarthy committed
60
61


Paul McCarthy's avatar
Paul McCarthy committed
62
The main repository can be found at:
Paul McCarthy's avatar
Paul McCarthy committed
63

Paul McCarthy's avatar
Paul McCarthy committed
64
https://git.fmrib.ox.ac.uk/fsl/pytreat-practicals-2020
Paul McCarthy's avatar
readme  
Paul McCarthy committed
65
66


Paul McCarthy's avatar
Paul McCarthy committed
67
68
69
70
Updates to the master branch should occur via merge requests. You can choose
to either work on a fork of this repository, or on a branch in this
repository. To contribute to the practicals using a fork:

Paul McCarthy's avatar
readme  
Paul McCarthy committed
71

Paul McCarthy's avatar
Paul McCarthy committed
72
1. Fork the upstream repository on gitlab
Paul McCarthy's avatar
readme  
Paul McCarthy committed
73

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

Paul McCarthy's avatar
Paul McCarthy committed
76
    ```
77
    git clone https://git.fmrib.ox.ac.uk/fsl/pytreat-practicals-2020.git
Paul McCarthy's avatar
Paul McCarthy committed
78
    ```
Paul McCarthy's avatar
Paul McCarthy committed
79
80
81

3. Add the upstream repository as a remote:

Paul McCarthy's avatar
Paul McCarthy committed
82
    ```
83
    git remote add upstream https://git.fmrib.ox.ac.uk/fsl/pytreat-practicals-2020.git
Paul McCarthy's avatar
Paul McCarthy committed
84
    ```
Paul McCarthy's avatar
Paul McCarthy committed
85
86
87

4. Make your changes on your local repository

Paul McCarthy's avatar
Paul McCarthy committed
88
5. Push your changes to your fork:
Paul McCarthy's avatar
Paul McCarthy committed
89

Paul McCarthy's avatar
Paul McCarthy committed
90
    ```
Paul McCarthy's avatar
Paul McCarthy committed
91
    git push origin master
Paul McCarthy's avatar
Paul McCarthy committed
92
    ```
Paul McCarthy's avatar
Paul McCarthy committed
93
94
95

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


Paul McCarthy's avatar
Paul McCarthy committed
98
99
100
101
102
Or, to contribute via a branch:

1. Make a local clone of the repository:

    ```
103
    git clone https://git.fmrib.ox.ac.uk/fsl/pytreat-practicals-2020.git
Paul McCarthy's avatar
Paul McCarthy committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
    ```

2. Create a branch for your work:

    ```
    git checkout -b my_cool_branch origin/master
    ```

3. Make your changes on this branch.

4. Push your changes to the gitlab repository:

    ```
    git push origin my_cool_branch
    ```

5. In gitlab, submit a merge request from your branch onto the master
   branch.


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

Paul McCarthy's avatar
Paul McCarthy committed
127
```
128
source $FSLDIR/fslpython/bin/activate fslpython
Paul McCarthy's avatar
Paul McCarthy committed
129
130
pip install notedown
source deactivate
131
fslpython -m notedown
Paul McCarthy's avatar
Paul McCarthy committed
132
133
134
ln -s $FSLDIR/fslpython/envs/fslpython/bin/notedown $FSLDIR/bin/fslnotedown
```

135
136
137
138
139
`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
140
141
142


```
143
fslnotedown my_markdown_file.md > my_notebook.ipynb
Paul McCarthy's avatar
Paul McCarthy committed
144
```