Version 33.1 by shailesh on 2021/10/11 08:20
Show last authors
1 (% class="box warningmessage" %)
2 (((
3 tutorials under development for Linux, Mac OS, Windows, Jupyter Lab.
4 )))
5
6
7 == Learning objectives ==
8
9 In this tutorial, you will learn how to install PyNN, together with the NEST, NEURON and Brian 2 simulators, in EBRAINS Jupyter Lab.
10
11 (% class="box infomessage" %)
12 (((
13 Note: There will be a separate tutorial for each environment.
14 )))
15
16 == Audience ==
17
18 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.
19
20 == Prerequisites ==
21
22 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.
23
24 == Format ==
25
26 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.
27
28 == Script ==
29
30 (% class="box successmessage" %)
31 (((
32 **Slide** showing tutorial title, PyNN logo, link to PyNN service page.
33 )))
34
35 Hello, my name is X.
36
37 This video is one of a series of tutorials for PyNN, which is Python software for modelling and simulating spiking neural networks.
38
39 For a list of the other tutorials in this series, you can visit ebrains.eu/service/pynn, that's p-y-n-n.
40
41 (% class="box successmessage" %)
42 (((
43 **Slide** listing learning objectives
44 )))
45
46 In this tutorial, I will guide you through setting up PyNN, together with the NEST, NEURON and Brian 2 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.
47
48 (% class="box successmessage" %)
49 (((
50 **Slide** listing prerequisites
51 )))
52
53 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.
54
55 EBRAINS JupyterLab only supports Python3, with the current default version being Python 3.6.9. This tutorial shall present 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.
56
57 (% class="box infomessage" %)
58 (((
59 **Screencast** - terminal
60 )))
61
62 We shall make use of virtual environments in this tutorial. 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 and thereby preventing unrequested changes in others, when any one of them is updated.
63
64 We begin by creating a directory for our project.
65
66 (% class="box infomessage" %)
67 (((
68 **Screencast** - terminal
69 \\(% style="color:#000000" %)cd ~~
70 mkdir pynn_project
71 cd pynn_project
72 )))
73
74 Next we shall create a virtual environment within this directory. Python 3 provides support for creating virtual environments. Since Python 3.6, the recommended method of creating a new virtual environment is as follows:
75
76 (% class="box errormessage" %)
77 (((
78 **Note:**
79 For older versions of Python 3, you might require to manually install `python3-venv` package before being able to run the below command. To install, run:
80 \\sudo apt-get install python3-venv
81 \\More recent versions of Python 3 (e.g. v3.9) already have this pre-installed.
82 )))
83
84 (% class="box infomessage" %)
85 (((
86 **Screencast** - terminal
87 \\(% style="color:#000000" %)python3 -m venv pynn_env
88 )))
89
90 (% class="box warningmessage" %)
91 (((
92 **Note:**
93 \\Observe that this command is as 'python3' and not simply 'python'. This is because Ubuntu 20, as 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 shall keep things simple and try to work with the bare minimum changes to the system.
94 )))
95
96 This will create a sub-directory named 'pynn_env' within our project directory, with several files and sub-directories. Let us take a look at the 'site-packages' directory.
97
98 (% class="box infomessage" %)
99 (((
100 **Screencast** - file explorer
101 \\(% style="color:#000000" %)<< show directory contents; especially lib/python3.9/site-packages >>
102 )))
103
104 As you see here, only a limited number of basic packages have currently been installed in this virtual environment. In the steps ahead, we shall install various other packages, and you shall see that these would be reflected here.
105
106 To enter into 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:
107
108 (% class="box infomessage" %)
109 (((
110 **Screencast** - terminal
111 \\(% style="color:#000000" %)source pynn_env/bin/activate
112 )))
113
114 Notice how this changes the command prompt to show the name of your virtual environment. In our case, we had 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.
115
116 (% class="box warningmessage" %)
117 (((
118 **Note:**
119 \\You might be required to run the above command every time you open a new terminal window. Do verify that the terminal command prompt indicates the name of your virtual environment to confirm that you have indeed activated it.
120 )))
121
122 Now that we have our project's virtual environment setup, we are now 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 shall demonstrate the installation of Brian2, NEURON and NEST simulators.
123
124 (% class="box errormessage" %)
125 (((
126 **Note:**
127 \\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:
128 [[(% style="color:#000000" %)http:~~/~~/neuralensemble.org/docs/PyNN/installation.html>>http://neuralensemble.org/docs/PyNN/installation.html]]
129 )))
130
131 We start here with the installation of Brian 2. Brian 2 can be installed simply using the pip command.
132
133 (% class="box infomessage" %)
134 (((
135 **Screencast** - terminal
136 \\(% style="color:#000000" %)pip install brian2
137 )))
138
139 This will install Brian 2, along with all its dependencies such as 'cython', 'numpy', etc. We can now go back into our virtual environment's 'site-packages' directory to see how it is now populated with all these packages.
140
141 (% class="box infomessage" %)
142 (((
143 **Screencast** - file explorer
144 \\(% style="color:#000000" %)<< show directory contents lib/python3.9/site-packages >>
145 )))
146
147 To confirm that we have properly installed Brian 2 on our computer, we can test as follows:
148
149 (% class="box infomessage" %)
150 (((
151 **Screencast** - terminal
152 \\(% style="color:#000000" %)python
153 \\import brian2
154 \\exit()
155 )))
156
157 (% class="box warningmessage" %)
158 (((
159 **Note: **
160 \\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 shall simply write 'python'. This is possible because once we have activated our virtual environment, this environment understands that both 'python' and 'python3' are equivalent.
161 )))
162
163 If there are no error messages here, and the import is successful, then we have completed installing Brian 2.
164
165 We shall 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.
166
167 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 could potentially be 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.
168
169 (% class="box infomessage" %)
170 (((
171 **Screencast** - terminal
172 \\(% style="color:#000000" %)sudo add-apt-repository ppa:nest-simulator/nest
173 sudo apt-get update
174 \\sudo apt-get install nest
175 )))
176
177 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:
178
179 (% class="box infomessage" %)
180 (((
181 **Screencast** - terminal
182 \\(% style="color:#000000" %)nest
183 )))
184
185 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. Let us next verify that this is indeed accessible via Python.
186
187 (% class="box infomessage" %)
188 (((
189 **Screencast** - terminal
190 \\(% style="color:#000000" %)python
191 \\import nest
192 \\exit()
193 )))
194
195 (% class="box warningmessage" %)
196 (((
197 **Note:**
198 \\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 and restart your computer, and try again. This time it should execute as expected.
199 )))
200
201 If there are no error messages here, and the import is successful, then we have completed installing NEST simulator, and are able to load it via Python.
202
203 We next move on to the third simulator, NEURON. The installation for NEURON used to be more involved previously, but can now be easily completed using the 'pip' command:
204
205 (% class="box infomessage" %)
206 (((
207 **Screencast** - terminal
208 \\(% style="color:#000000" %)pip install neuron
209 )))
210
211 This installs the NEURON simulator on your system. To confirm that we have properly installed NEURON, we can test as follows:
212
213 (% class="box infomessage" %)
214 (((
215 **Screencast** - terminal
216 \\(% style="color:#000000" %)nrngui
217 )))
218
219 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. Let us next verify that this is indeed accessible via Python.
220
221 (% class="box infomessage" %)
222 (((
223 **Screencast** - terminal
224 \\(% style="color:#000000" %)python
225 \\from neuron import h
226 \\exit()
227 )))
228
229 If there are no error messages here, and the import is successful, then we have completed installing NEURON simulator, and are able to load it via Python.
230
231 Now that we have installed all the simulators we intend to use, we move on to installing PyNN itself. As PyNN is a Python package, we can install it easily using the 'pip' command:
232
233 (% class="box infomessage" %)
234 (((
235 **Screencast** - terminal
236 \\(% style="color:#000000" %)pip install pyNN
237 )))
238
239 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:
240
241 (% class="box infomessage" %)
242 (((
243 **Screencast** - terminal
244
245 (% style="color:#000000" %)python
246 \\import pyNN.brian2 as sim
247
248 (% style="color:#000000" %)sim.setup()
249
250 (% style="color:#000000" %)sim.end()
251 )))
252
253 This confirms that PyNN has been properly setup, and also that is able to employ Brian 2. To verify similary test that PyNN is also able to communicate with NEURON and NEST simulators:
254
255 (% class="box infomessage" %)
256 (((
257 **Screencast** - terminal
258
259 (% style="color:#000000" %)python
260 \\import pyNN.nest as sim
261
262 (% style="color:#000000" %)sim.setup()
263
264 (% style="color:#000000" %)sim.end()
265
266
267
268 (% style="color:#000000" %)import pyNN.neuron as sim
269
270 (% style="color:#000000" %)sim.setup()
271
272 (% style="color:#000000" %)sim.end()
273 )))
274
275 This confirms that all the required software packages have been successfully completed, and are functioning as expected.
276
277 (% class="box successmessage" %)
278 (((
279 **Slide** recap of learning objectives
280 )))
281
282 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, do 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 these more advanced features of PyNN, so keep an eye on the EBRAINS website.
283
284 (% class="box successmessage" %)
285 (((
286 **Slide** useful links
287 \\[[(% style="color:#000000" %)https:~~/~~/realpython.com/python-virtual-environments-a-primer/>>https://realpython.com/python-virtual-environments-a-primer/]](%%)
288 [[(% style="color:#000000" %)https:~~/~~/briansimulator.org/install/>>https://briansimulator.org/install/]](%%)
289 [[(% 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]](%%)
290 [[(% style="color:#000000" %)https:~~/~~/neuron.yale.edu/neuron/>>https://neuron.yale.edu/neuron/]]
291 )))
292
293 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.
294
295 (% class="box successmessage" %)
296 (((
297 **Slide** acknowledgements, contact information
298 )))
299
300 (% class="wikigeneratedid" %)
301 PyNN has been developed by many different people, with financial support from several different organisations. I'd like to mention in particular the CNRS and the European Commission, through the FACETS, BrainScaleS and Human Brain Project grants.
302
303 (% class="wikigeneratedid" %)
304 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.