Version 38.1 by annedevismes on 2021/10/19 07:08
Show last authors
1 (% class="box warningmessage" %)
2 (((
3 tutorials under development for Linux, Mac OS, Windows, Jupyter Lab.
4 )))
5
6 (% class="box errormessage" %)
7 (((
8 Under development! Awaiting EBRAINS JupyterLab SPACK implementation.
9 )))
10
11 == Learning objectives ==
12
13 In this tutorial, you will learn how to install PyNN, together with the NEST, NEURON, and Brian 2 simulators, in EBRAINS Jupyter Lab.
14
15 (% class="box infomessage" %)
16 (((
17 Note: There will be a separate tutorial for each environment.
18 )))
19
20 == Audience ==
21
22 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.
23
24 == Prerequisites ==
25
26 To follow this tutorial, you will need an EBRAINS account. You should know how to create and use Jupyter notebooks in the EBRAINS Jupyter Lab.
27
28 == Format ==
29
30 These tutorials will be screencasts, in which the presenter runs commands in a Jupyer notebook, and the viewer is expected to follow along. The intended duration is 10-15 minutes.
31
32 == Script ==
33
34 (% class="box successmessage" %)
35 (((
36 **Slide** showing tutorial title, PyNN logo, link to PyNN service page.
37 )))
38
39 Hello, my name is X.
40
41 This video is one of a series of tutorials for PyNN, which is Python software for modelling and simulating spiking neural networks.
42
43 For a list of the other tutorials in this series, you can visit ebrains.eu/service/pynn, that's p-y-n-n.
44
45 (% class="box successmessage" %)
46 (((
47 **Slide** listing learning objectives
48 )))
49
50 In this tutorial, I will guide you through setting up PyNN, together with the Brian 2, NEST, and NEURON simulators, in the EBRAINS Collaboratory's JupyterLab. Note that we have a dedicated version of this tutorial for other environments, such as Linux, Mac OS, and Windows.
51
52 (% class="box successmessage" %)
53 (((
54 **Slide** listing prerequisites
55 )))
56
57 To follow this tutorial, you will need an EBRAINS account. Interested users with a current affiliation to an academic institution can directly create an account at [[https:~~/~~/ebrains.eu/register/>>https://ebrains.eu/register/]]. Users without such an affiliation may submit a request for an account.
58
59 EBRAINS JupyterLab only supports Python3, with the current default version being Python 3.6.9. This tutorial presents the steps for such an environment, but changes required to the steps below following upgrades to more recent versions of Python are expected to be minimal.
60
61 (% class="box infomessage" %)
62 (((
63 **Screencast** - terminal
64 )))
65
66 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.
67
68 We begin by creating a directory for our project.
69
70 (% class="box infomessage" %)
71 (((
72 **Screencast** - terminal
73 \\(% style="color:#000000" %)cd ~~
74 mkdir pynn_project
75 cd pynn_project
76 )))
77
78 Next, we will create a virtual environment within this directory. Python 3 provides support for creating virtual environments. Since Python 3.6, the recommended method for creating a new virtual environment is as follows:
79
80 (% class="box errormessage" %)
81 (((
82 **Note**
83 For older versions of Python 3, you be might required to manually install `python3-venv` package before being able to run the below command. To install, run:
84 \\sudo apt-get install python3-venv
85 \\More recent versions of Python 3 (e.g. v3.9) already have this pre-installed.
86 )))
87
88 (% class="box infomessage" %)
89 (((
90 **Screencast** - terminal
91 \\(% style="color:#000000" %)python3 -m venv pynn_env
92 )))
93
94 (% class="box warningmessage" %)
95 (((
96 **Note**
97 \\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.
98 )))
99
100 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.
101
102 (% class="box infomessage" %)
103 (((
104 **Screencast** - file explorer
105 \\(% style="color:#000000" %)<< show directory contents; especially lib/python3.9/site-packages >>
106 )))
107
108 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.
109
110 To enter this virtual environment, and thereby use its resources in isolation from other projects on your computer, we require to "activate" it. This is achieved by running the command:
111
112 (% class="box infomessage" %)
113 (((
114 **Screencast** - terminal
115 \\(% style="color:#000000" %)source pynn_env/bin/activate
116 )))
117
118 Notice how this changes the command prompt to show the name of your virtual environment. In our case, we 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.
119
120 (% class="box warningmessage" %)
121 (((
122 **Note**
123 \\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.
124 )))
125
126 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, NEURON, and NEST simulators.
127
128 (% class="box errormessage" %)
129 (((
130 **Note:**
131 \\If you have previously already installed NEURON or NEST on your system and are installing PyNN now, then you would require to compile NEURON's NMODL fles and NEST's extensions manually. For more instructions on this, take a look at:
132 [[(% style="color:#000000" %)http:~~/~~/neuralensemble.org/docs/PyNN/installation.html>>http://neuralensemble.org/docs/PyNN/installation.html]]
133 )))
134
135 We start here with the installation of Brian 2. Brian 2 can be installed simply by using the pip command.
136
137 (% class="box infomessage" %)
138 (((
139 **Screencast** - terminal
140 \\(% style="color:#000000" %)pip install brian2
141 )))
142
143 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.
144
145 (% class="box infomessage" %)
146 (((
147 **Screencast** - file explorer
148 \\(% style="color:#000000" %)<< show directory contents lib/python3.9/site-packages >>
149 )))
150
151 To confirm that we have properly installed Brian 2 on our computer, we can test as follows:
152
153 (% class="box infomessage" %)
154 (((
155 **Screencast** - terminal
156 \\(% style="color:#000000" %)python
157 \\import brian2
158 \\exit()
159 )))
160
161 (% class="box warningmessage" %)
162 (((
163 **Note:**
164 \\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.
165 )))
166
167 If there are no error messages here, and the import is successful, we have completed installing Brian 2.
168
169 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.
170
171 At the time of creating this tutorial, the lastest 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.
172
173 (% class="box infomessage" %)
174 (((
175 **Screencast** - terminal
176 \\(% style="color:#000000" %)sudo add-apt-repository ppa:nest-simulator/nest
177 sudo apt-get update
178 \\sudo apt-get install nest
179 )))
180
181 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:
182
183 (% class="box infomessage" %)
184 (((
185 **Screencast** - terminal
186 \\(% style="color:#000000" %)nest
187 )))
188
189 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 next verify that this is indeed accessible via Python.
190
191 (% class="box infomessage" %)
192 (((
193 **Screencast** - terminal
194 \\(% style="color:#000000" %)python
195 \\import nest
196 \\exit()
197 )))
198
199 (% class="box warningmessage" %)
200 (((
201 **Note**
202 \\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.
203 )))
204
205 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.
206
207 We next move on to the third simulator, NEURON. The installation for NEURON used to be more complex but can now be easily completed by using the 'pip' command:
208
209 (% class="box infomessage" %)
210 (((
211 **Screencast** - terminal
212 \\(% style="color:#000000" %)pip install neuron
213 )))
214
215 This installs the NEURON simulator on your system. To confirm that we have properly installed NEURON, we can test as follows:
216
217 (% class="box infomessage" %)
218 (((
219 **Screencast** - terminal
220 \\(% style="color:#000000" %)nrngui
221 )))
222
223 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.
224
225 (% class="box infomessage" %)
226 (((
227 **Screencast** - terminal
228 \\(% style="color:#000000" %)python
229 \\from neuron import h
230 \\exit()
231 )))
232
233 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.
234
235 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 by using the 'pip' command:
236
237 (% class="box infomessage" %)
238 (((
239 **Screencast** - terminal
240 \\(% style="color:#000000" %)pip install pyNN
241 )))
242
243 (% class="box warningmessage" %)
244 (((
245 **Note**
246 \\Note that PyNN project is spelt with a captial P, small y, and two captital N. But the Python module, as seen here, is spelt starting with a small P. This is in line with general Python convention, where package names start with small alphabets.
247 )))
248
249 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:
250
251 (% class="box infomessage" %)
252 (((
253 **Screencast** - terminal
254
255 (% style="color:#000000" %)python
256 \\import pyNN.brian2 as sim
257
258 (% style="color:#000000" %)sim.setup()
259
260 (% style="color:#000000" %)sim.end()
261 )))
262
263 This confirms that PyNN has been properly setup, and also that is able to employ Brian 2. To verify that PyNN is also able to communicate with NEURON and NEST simulators, we can do the following:
264
265 (% class="box infomessage" %)
266 (((
267 **Screencast** - terminal
268
269 (% style="color:#000000" %)python
270 \\import pyNN.nest as sim
271
272 (% style="color:#000000" %)sim.setup()
273
274 (% style="color:#000000" %)sim.end()
275
276
277
278 (% style="color:#000000" %)import pyNN.neuron as sim
279
280 (% style="color:#000000" %)sim.setup()
281
282 (% style="color:#000000" %)sim.end()
283 )))
284
285 This confirms that all the required software packages have been successfully completed and are functioning as expected.
286
287 (% class="box successmessage" %)
288 (((
289 **Slide** recap of learning objectives
290 )))
291
292 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.
293
294 (% class="box successmessage" %)
295 (((
296 **Slide** useful links
297 \\[[(% style="color:#000000" %)https:~~/~~/realpython.com/python-virtual-environments-a-primer/>>https://realpython.com/python-virtual-environments-a-primer/]](%%)
298 [[(% style="color:#000000" %)https:~~/~~/briansimulator.org/install/>>https://briansimulator.org/install/]](%%)
299 [[(% 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]](%%)
300 [[(% style="color:#000000" %)https:~~/~~/neuron.yale.edu/neuron/>>https://neuron.yale.edu/neuron/]]
301 )))
302
303 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.
304
305 (% class="box successmessage" %)
306 (((
307 **Slide** acknowledgements, contact information
308 )))
309
310 (% class="wikigeneratedid" %)
311 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.
312
313 (% class="wikigeneratedid" %)
314 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.