Attention: Data Proxy will be migrated from SWIFT to S3 storage at Friday, the 9th of May 2025 starting from 9pm CEST (my timezone). For more details, please join the rocket chat channel https://chat.ebrains.eu/channel/data-proxy-user-group


Last modified by adavison on 2022/10/04 13:53

From version 55.1
edited by shailesh
on 2022/01/31 15:56
Change comment: There is no comment for this version
To version 42.1
edited by annedevismes
on 2021/10/19 08:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.shailesh
1 +XWiki.annedevismes
Content
... ... @@ -1,6 +1,6 @@
1 1  == Learning objectives ==
2 2  
3 -In this tutorial, you will learn how to install PyNN, together with the Brian 2, NEST and NEURON simulators, on Linux.
3 +In this tutorial, you will learn how to install PyNN, together with the NEST, NEURON, and Brian 2 simulators, on Linux.
4 4  
5 5  (% class="box infomessage" %)
6 6  (((
... ... @@ -37,7 +37,7 @@
37 37  **Slide** listing learning objectives
38 38  )))
39 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.
40 +In this tutorial, I will guide you through setting up PyNN, together with the Brian 2, NEST, and NEURON, and 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 41  
42 42  (% class="box successmessage" %)
43 43  (((
... ... @@ -44,7 +44,7 @@
44 44  **Slide** listing prerequisites
45 45  )))
46 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.
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 using Ubuntu OS. Also, this tutorial focuses only on Python 3, because Python 2 has now been deprecated. 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 48  
49 49  (% class="box errormessage" %)
50 50  (((
... ... @@ -71,13 +71,20 @@
71 71  
72 72  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.
73 73  
74 +(% class="box errormessage" %)
75 +(((
76 +**Note**
77 +
78 +
79 +For older versions of Python 3, you might be required 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 +
74 74  (% class="box infomessage" %)
75 75  (((
76 76  **Screencast** - terminal
77 -
78 -(% style="color:#000000" %)
79 -sudo apt-get install python3-venv
80 -python3 -m venv pynn_env
87 +\\(% style="color:#000000" %)python3 -m venv pynn_env
81 81  )))
82 82  
83 83  (% class="box warningmessage" %)
... ... @@ -116,16 +116,6 @@
116 116  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.
117 117  )))
118 118  
119 -Before we proceed, let us run the following commands to ensure that our environment is setup as required:
120 -
121 -
122 -(% class="box infomessage" %)
123 -(((
124 -**Screencast** - terminal
125 -\\(% style="color:#000000" %)pip install ~-~-upgrade pip
126 -sudo apt install make
127 -)))
128 -
129 129  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.
130 130  
131 131  (% class="box errormessage" %)
... ... @@ -171,7 +171,7 @@
171 171  
172 172  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.
173 173  
174 -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.
171 +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 will 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.
175 175  
176 176  (% class="box infomessage" %)
177 177  (((
... ... @@ -187,11 +187,9 @@
187 187  (((
188 188  **Screencast** - terminal
189 189  \\(% style="color:#000000" %)nest
190 -
191 -(% style="color:#000000" %)exit
192 192  )))
193 193  
194 -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.
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. Let us next verify that this is indeed accessible via Python.
195 195  
196 196  (% class="box infomessage" %)
197 197  (((
... ... @@ -209,7 +209,7 @@
209 209  
210 210  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.
211 211  
212 -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.
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.
213 213  
214 214  (% class="box infomessage" %)
215 215  (((
... ... @@ -266,7 +266,7 @@
266 266  (% style="color:#000000" %)sim.end()
267 267  )))
268 268  
269 -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:
264 +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 NEURON and NEST simulators, we can do the following:
270 270  
271 271  (% class="box infomessage" %)
272 272  (((
... ... @@ -290,14 +290,6 @@
290 290  
291 291  This confirms that all the required software packages have been successfully completed and are functioning as expected.
292 292  
293 -As a last step, we will install a Python package named 'matplotlib' that would come in handy in the tutorials ahead.
294 -
295 -(% class="box infomessage" %)
296 -(((
297 -**Screencast** - terminal
298 -\\(% style="color:#000000" %)pip install matplotlib
299 -)))
300 -
301 301  (% class="box successmessage" %)
302 302  (((
303 303  **Slide** recap of learning objectives