Wiki source code of 02. Installing PyNN - Linux

Version 56.1 by shailesh on 2022/01/31 16:00
Show last authors
1 == Learning objectives ==
2
3 In this tutorial, you will learn how to install PyNN, together with the Brian 2, NEST and NEURON simulators, on Linux.
4
5 (% class="box infomessage" %)
6 (((
7 Note: There will be a separate tutorial for each environment.
8 )))
9
10 == Audience ==
11
12 This tutorial is intended for people with at least a basic knowledge of neuroscience (high-school level or above) and basic familiarity with the Python programming language. It should also be helpful for people who already have advanced knowledge of neuroscience and neural simulation, who simply wish to learn how to use PyNN and how it differs from other simulation tools they know.
13
14 == Prerequisites ==
15
16 To follow this tutorial, you will need a computer with Linux and a good network connection. You will need to know how to open the terminal application for your operating system.
17
18 == Format ==
19
20 These tutorials will be screencasts, in which the presenter runs commands in a terminal, and the viewer is expected to follow along. The intended duration is 10-15 minutes.
21
22 == Script ==
23
24 (% class="box successmessage" %)
25 (((
26 **Slide** showing tutorial title, PyNN logo, link to PyNN service page.
27 )))
28
29 Hello, my name is X.
30
31 This video is one of a series of tutorials for PyNN, which is Python software for modelling and simulating spiking neural networks.
32
33 For a list of the other tutorials in this series, you can visit ebrains.eu/service/pynn, that's p-y-n-n.
34
35 (% class="box successmessage" %)
36 (((
37 **Slide** listing learning objectives
38 )))
39
40 In this tutorial, I will guide you through setting up PyNN, together with the Brian 2, NEST, and NEURON simulators, on a Linux  environment. Note that we have a dedicated version of this tutorial for other environments, such as Mac OS, Windows, and EBRAINS Jupyter Lab.
41
42 (% class="box successmessage" %)
43 (((
44 **Slide** listing prerequisites
45 )))
46
47 I will demonstrate the installation on a computer with Ubuntu 20.04 OS installed. The steps are likely to remain very similar for other versions of Ubuntu OS and are also not expected to vary significantly for other Linux distributions. In the latter case, you can find information on the Internet about how to carry out the equivalent of the tasks demonstrated here. Also, this tutorial focuses only on Python 3, because Python 2 is no longer supported. It is recommended to use Python version 3.6 or higher. I will be using Python 3.8.10 in this tutorial, because it is the default version provided with Ubuntu 20.04.
48
49 (% class="box errormessage" %)
50 (((
51 **Note**
52 Having multiple versions of Python on your system can produce issues while installing NEST. The method shown below will install NEST for the default version of Python provided by your Ubuntu OS. For example, for Ubuntu 18.04, this might be Python 3.6.9, and for Ubuntu 20.04, it will likely be 3.8.10. If you wish to associate the NEST installation with a different Python version installed on your system, please refer to the NEST installation instructions to do so on their website.
53 )))
54
55 (% class="box infomessage" %)
56 (((
57 **Screencast** - terminal
58 )))
59
60 In this tutorial, we will make use of virtual environments. This allows multiple Python projects to coexist on the same computer, even when they might have different, and even conflicting, requirements. It helps isolate projects, thereby preventing unrequested changes in others, when any one of them is updated.
61
62 Let's begin by creating a directory for our project.
63
64 (% class="box infomessage" %)
65 (((
66 **Screencast** - terminal
67 \\(% style="color:#000000" %)cd ~~
68 mkdir pynn_project
69 cd pynn_project
70 )))
71
72 Next, we will create a virtual environment within this directory. Python 3 provides support for creating virtual environments. To use this, we first install the package named 'python3-venv':
73
74 (% class="box infomessage" %)
75 (((
76 **Screencast** - terminal
77
78 (% style="color:#000000" %)
79 sudo apt-get install python3-venv
80 )))
81
82 And once this is installed, we can create a new virtual environment as follows.
83
84 (% class="box infomessage" %)
85 (((
86 **Screencast** - terminal
87
88 (% style="color:#000000" %)
89 sudo apt-get install python3-venv
90 python3 -m venv pynn_env
91 )))
92
93 (% class="box warningmessage" %)
94 (((
95 **Note**
96
97
98 Note that this command is 'python3' and not simply 'python'. This is because Ubuntu 20, by default, understands only the former. You can find on the Internet various ways to have 'python' also refer to 'python3', but for the purposes of this tutorial, we keep things simple and try to work with the bare minimum changes to the system.
99 )))
100
101 This will create a sub-directory named 'pynn_env' within our project directory, with several files and sub-directories. Let's take a look at the 'site-packages' directory.
102
103 (% class="box infomessage" %)
104 (((
105 **Screencast** - file explorer
106 \\(% style="color:#000000" %)<< show directory contents; especially lib/python3.8/site-packages >>
107 )))
108
109 As you see here, only a limited number of basic packages have currently been installed in this virtual environment. In the steps ahead, we will install various other packages, which you will be able to see here.
110
111 To enter this virtual environment, and thereby use its resources in isolation from other projects on your computer, we have to "activate" it. This is achieved by running the command:
112
113 (% class="box infomessage" %)
114 (((
115 **Screencast** - terminal
116 \\(% style="color:#000000" %)source pynn_env/bin/activate
117 )))
118
119 Notice how this changes the command prompt to show the name of your virtual environment. In our case, we have named it 'pynn_env', and this is now reflected as a prefix to the command prompt. This confirms that we are now in our new virtual environment.
120
121 (% class="box warningmessage" %)
122 (((
123 **Note**
124
125
126 You might be required to run the above command every time you open a new terminal window. Check that the terminal command prompt indicates the name of your virtual environment to confirm that you have indeed activated it.
127 )))
128
129 Before we proceed, let us run the following commands to ensure that our environment is setup as required:
130
131
132 (% class="box infomessage" %)
133 (((
134 **Screencast** - terminal
135 \\(% style="color:#000000" %)pip install ~-~-upgrade pip
136 sudo apt install make
137 )))
138
139 Now that we have our project's virtual environment setup, we are ready to install PyNN and other simulators. In general, it is advisable to install the various simulators (especially NEURON and NEST) prior to installing PyNN, because PyNN will then auto compile NEURON's NMODL fles and NEST's extensions during installation. In this tutorial, we will adopt this approach and begin by installing the simulators. For the purposes of this tutorial, we will demonstrate the installation of Brian2, NEST, and NEURON simulators.
140
141 (% class="box errormessage" %)
142 (((
143 **Note:**
144 \\If you have previously installed NEURON or NEST on your system and are installing PyNN now, you will have to compile NEURON's NMODL fles and NEST's extensions manually. For more instructions on this, take a look at:
145 [[(% style="color:#000000" %)http:~~/~~/neuralensemble.org/docs/PyNN/installation.html>>http://neuralensemble.org/docs/PyNN/installation.html]]
146 )))
147
148 We start here with the installation of Brian 2. Brian 2 can be installed simply by using the pip command.
149
150 (% class="box infomessage" %)
151 (((
152 **Screencast** - terminal
153 \\(% style="color:#000000" %)pip install brian2
154 )))
155
156 This will install Brian 2, along with all its dependencies such as 'cython', 'numpy', and so on. We can now go back to our virtual environment's 'site-packages' directory to see how it is populated with all these packages.
157
158 (% class="box infomessage" %)
159 (((
160 **Screencast** - file explorer
161 \\(% style="color:#000000" %)<< show directory contents lib/python3.8/site-packages >>
162 )))
163
164 To confirm that we have properly installed Brian 2 on our computer, we can test as follows:
165
166 (% class="box infomessage" %)
167 (((
168 **Screencast** - terminal
169 \\(% style="color:#000000" %)python
170 \\import brian2
171 \\exit()
172 )))
173
174 (% class="box warningmessage" %)
175 (((
176 **Note**
177 \\You might remember that, earlier in this tutorial, we had to use the term 'python3' to run Python on our system. But here, as in the rest of this tutorial, we will simply write 'python'. This is possible because, once we have activated our virtual environment, this environment understands that both 'python' and 'python3' are equivalent.
178 )))
179
180 If there are no error messages here, and the import is successful, we have completed the installation of Brian 2.
181
182 We will now move on to install the NEST simulator. Unlike Brian 2, NEST is not a Python package and therefore, it cannot be installed via the 'pip' command.
183
184 At the time of creating this tutorial, the latest version of NEST is v3.1. This is currently supported by PyNN v0.10, and it is likely that other versions of NEST are potentially incompatible with this version of PyNN. The installation is done by first adding the PPA repository for NEST and updating apt, followed by the installation of NEST itself.
185
186 (% class="box infomessage" %)
187 (((
188 **Screencast** - terminal
189 \\(% style="color:#000000" %)sudo add-apt-repository ppa:nest-simulator/nest
190 sudo apt-get update
191 \\sudo apt-get install nest
192 )))
193
194 This installs the NEST module along with PyNEST, which is a Python interface for controlling the NEST kernel. This allows us to use NEST via Python. To confirm that we have properly installed NEST on our computer, we can test as follows:
195
196 (% class="box infomessage" %)
197 (((
198 **Screencast** - terminal
199 \\(% style="color:#000000" %)nest
200
201 (% style="color:#000000" %)exit
202 )))
203
204 This will display the NEST banner, which mentions the version amongst other info. Here, as we can see, we have now installed NEST v3.1 on our system. Next, let's verify that this is indeed accessible via Python.
205
206 (% class="box infomessage" %)
207 (((
208 **Screencast** - terminal
209 \\(% style="color:#000000" %)python
210 \\import nest
211 \\exit()
212 )))
213
214 (% class="box warningmessage" %)
215 (((
216 **Note**
217 \\I find that I receive a "no module named nest" error when trying this right after installing NEST. But it succeeds after a restart. So, if you do observe an error, close all programs, restart your computer, and try again. This time, it should execute as expected.
218 )))
219
220 If there are no error messages here, and the import is successful, we have completed installing NEST simulator and are able to load it via Python.
221
222 We next move on to the third simulator, NEURON. Similar to Brian2, the installation for NEURON can be easily done via the 'pip' command. Do note that this method of installation does not auto-enable MPI support, which would be required for running simulations in parallel. Do visit the NEURON website if you wish to install on clusters or HPC machines.
223
224 (% class="box infomessage" %)
225 (((
226 **Screencast** - terminal
227 \\(% style="color:#000000" %)pip install neuron
228 )))
229
230 This installs the NEURON simulator on our system. To confirm that we have properly installed NEURON, we can test as follows:
231
232 (% class="box infomessage" %)
233 (((
234 **Screencast** - terminal
235 \\(% style="color:#000000" %)nrniv
236 \\quit()
237 )))
238
239 This will display the NEURON banner, which mentions the version amongst other info. Here, as we can see, we have now installed NEURON v8.0.0 on our system. Next, let's verify that this is indeed accessible via Python.
240
241 (% class="box infomessage" %)
242 (((
243 **Screencast** - terminal
244 \\(% style="color:#000000" %)python
245 \\from neuron import h
246 \\exit()
247 )))
248
249 If there are no error messages here, and the import is successful, we have completed installing NEURON simulator and are able to load it via Python.
250
251 Now that we have installed all the simulators we intend to use, we move on to installing PyNN itself. Because PyNN is a Python package, we can install it easily using the 'pip' command:
252
253 (% class="box infomessage" %)
254 (((
255 **Screencast** - terminal
256 \\(% style="color:#000000" %)pip install PyNN
257 )))
258
259 (% class="box warningmessage" %)
260 (((
261 **Note**
262 \\Note that PyNN project is spelt with a captial P, small y, and two captital N. The pip command is case-insensitive, so you may write it differently here. But the Python module, as we will see later, is case-sensitive and is spelt starting with a small P. This is in line with general Python convention, whereby package names start with small letters. Thus, while importing PyNN module via Python, it needs to be written as 'pyNN'.
263 )))
264
265 To verify that PyNN has been successfully installed on our system and that it is indeed able to communicate with the other simulators that we installed earlier, we can try running:
266
267 (% class="box infomessage" %)
268 (((
269 **Screencast** - terminal
270
271 (% style="color:#000000" %)python
272 \\import pyNN.brian2 as sim
273
274 (% style="color:#000000" %)sim.setup()
275
276 (% style="color:#000000" %)sim.end()
277 )))
278
279 This confirms that PyNN has been properly setup and also that it is able to employ Brian 2. To verify that PyNN is also able to communicate with NEST and NEURON simulators, we can do the following:
280
281 (% class="box infomessage" %)
282 (((
283 **Screencast** - terminal
284
285 (% style="color:#000000" %)python
286 \\import pyNN.nest as sim
287
288 (% style="color:#000000" %)sim.setup()
289
290 (% style="color:#000000" %)sim.end()
291
292
293
294 (% style="color:#000000" %)import pyNN.neuron as sim
295
296 (% style="color:#000000" %)sim.setup()
297
298 (% style="color:#000000" %)sim.end()
299 )))
300
301 This confirms that all the required software packages have been successfully completed and are functioning as expected.
302
303 As a last step, we will install a Python package named 'matplotlib' that would come in handy in the tutorials ahead.
304
305 (% class="box infomessage" %)
306 (((
307 **Screencast** - terminal
308 \\(% style="color:#000000" %)pip install matplotlib
309 )))
310
311 (% class="box successmessage" %)
312 (((
313 **Slide** recap of learning objectives
314 )))
315
316 That is the end of this tutorial, in which I've demonstrated how to install PyNN and other required simulators in a Linux system. You are now ready to start modeling! To learn about model development in PyNN, take a look at our next tutorial. Also, we will be releasing a series of tutorials, throughout the rest of 2021 and 2022, to introduce more advanced features of PyNN, so keep an eye on the EBRAINS website.
317
318 (% class="box successmessage" %)
319 (((
320 **Slide** useful links
321 \\[[(% style="color:#000000" %)https:~~/~~/realpython.com/python-virtual-environments-a-primer/>>https://realpython.com/python-virtual-environments-a-primer/]](%%)
322 [[(% style="color:#000000" %)https:~~/~~/briansimulator.org/install/>>https://briansimulator.org/install/]](%%)
323 [[(% style="color:#000000" %)https:~~/~~/nest-simulator.readthedocs.io/en/v3.1/installation/index.html>>https://nest-simulator.readthedocs.io/en/v3.1/installation/index.html]](%%)
324 [[(% style="color:#000000" %)https:~~/~~/neuron.yale.edu/neuron/>>https://neuron.yale.edu/neuron/]]
325 )))
326
327 We have listed here some links that might be of interest to users who wish to find more details about the various softwares employed in this tutorial.
328
329 (% class="box successmessage" %)
330 (((
331 **Slide** acknowledgements, contact information
332 )))
333
334 (% class="wikigeneratedid" %)
335 PyNN has been developed by many different people, with financial support from several organisations. I'd like to mention in particular the CNRS and the European Commission, through the FACETS, BrainScaleS, and Human Brain Project grants.
336
337 (% class="wikigeneratedid" %)
338 For more information, visit neuralensemble.org/PyNN. If you have questions you can contact us through the PyNN Github project, the NeuralEnsemble forum, EBRAINS support, or the EBRAINS Community.