examples/running_scipion_tutorials.md
... ...
@@ -0,0 +1,58 @@
1
+## SCIPION: running tutorials without write privileges
2
+Scipion tutorials (https://scipion-em.github.io/docs/docs/user/user-documentation.html#tutorials) are launched by typing, for example `scipion tutorial intro` into the terminal. However, these tutorials will try and download the tutorial data into the $SCIPION_HOME/data/tests directory. Many SBGrid 'site' installations will have the /programs directory set as 'read and execute' only, with no write permissions in the /programs tree.
3
+
4
+To be able to run Scipion tutorials without write privileges in the /programs tree, Scipion needs to have its configuration file modified to save tests in a directory with write privileges.
5
+
6
+The configuration file is located at ~/.config/scipion/scipion.conf and should look similar to this:
7
+```
8
+[DIRS_LOCAL]
9
+SCIPION_USER_DATA = ~/ScipionUserData
10
+SCIPION_LOGS = %(SCIPION_USER_DATA)s/logs
11
+SCIPION_TMP = %(SCIPION_USER_DATA)s/tmp
12
+
13
+[PACKAGES]
14
+EM_ROOT = software/em
15
+XMIPP_HOME = %(EM_ROOT)s/xmipp
16
+CHIMERA_HOME = %(EM_ROOT)s/chimera-1.13.1
17
+CHIMERA_HEADLESS_HOME = %(EM_ROOT)s/chimera_headless
18
+VMD_HOME = %(EM_ROOT)s/vmd
19
+
20
+[VARIABLES]
21
+SCIPION_NOTES_PROGRAM =
22
+SCIPION_NOTES_ARGS =
23
+SCIPION_NOTES_FILE = notes.txt
24
+SCIPION_NOTIFY = False
25
+VIEWERS = {"Volume":["pyworkflow.em.viewers.viewers_data.DataViewer"]}
26
+```
27
+
28
+Open the file in your favourite editor, and add a line
29
+
30
+SCIPION_TESTS = ~/scipion/tests
31
+
32
+in the [DIRS_LOCAL] section. You can specify any directory you want the tutorials to be saved, provided you have write privileges in the directory.
33
+
34
+Your modified ~/.config/scipion/scipion.conf file should now look similar to this:
35
+```
36
+[DIRS_LOCAL]
37
+SCIPION_USER_DATA = ~/ScipionUserData
38
+SCIPION_LOGS = %(SCIPION_USER_DATA)s/logs
39
+SCIPION_TMP = %(SCIPION_USER_DATA)s/tmp
40
+SCIPION_TESTS = ~/scipion/tests
41
+
42
+[PACKAGES]
43
+EM_ROOT = software/em
44
+XMIPP_HOME = %(EM_ROOT)s/xmipp
45
+CHIMERA_HOME = %(EM_ROOT)s/chimera-1.13.1
46
+CHIMERA_HEADLESS_HOME = %(EM_ROOT)s/chimera_headless
47
+VMD_HOME = %(EM_ROOT)s/vmd
48
+
49
+[VARIABLES]
50
+SCIPION_NOTES_PROGRAM =
51
+SCIPION_NOTES_ARGS =
52
+SCIPION_NOTES_FILE = notes.txt
53
+SCIPION_NOTIFY = False
54
+VIEWERS = {"Volume":["pyworkflow.em.viewers.viewers_data.DataViewer"]}
55
+```
56
+
57
+After saving the file, running `scipion tutorial intro` will save the tutorial project in the ~/scipion/tests directory, and you should be able to follow the tutorials as described.
58
+