Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.adavison
	1	+XWiki.annedevismes

Content

...	...	@@ -1,15 +6,10 @@
1		-(% class="box successmessage" %)
2		-(((
3		-Video: [[https:~~/~~/www.youtube.com/watch?v=BZB7xKUK8Vc>>https://www.youtube.com/watch?v=BZB7xKUK8Vc]]
4		-)))
5		-
6	6	== Learning objectives ==
7	7
8		-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.
9	9
10	10	(% class="box infomessage" %)
11	11	(((
12		-Note: We are preparing tutorials for Windows and Mac OS
	7	+Note: There will be a separate tutorial for each environment.
13	13	)))
14	14
15	15	== Audience ==
...	...	@@ -42,7 +42,7 @@
42	42	**Slide** listing learning objectives
43	43	)))
44	44
45		-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 NEST, NEURON, and Brian 2 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.
46	46
47	47	(% class="box successmessage" %)
48	48	(((
...	...	@@ -49,7 +49,7 @@
49	49	**Slide** listing prerequisites
50	50	)))
51	51
52		-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.
53	53
54	54	(% class="box errormessage" %)
55	55	(((
...	...	@@ -74,24 +74,22 @@
74	74	cd pynn_project
75	75	)))
76	76
77		-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':
	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.
78	78
79		-(% class="box infomessage" %)
	74	+(% class="box errormessage" %)
80	80	(((
81		-**Screencast** - terminal
	76	+**Note**
82	82
83		-(% style="color:#000000" %)
84		-sudo apt-get install python3-venv
	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.
85	85	)))
86	86
87		-And once this is installed, we can create a new virtual environment by typing 'python3', '-m venv' to indicate the name module of the module we just installed, followed by the name we wish to assign to our virtual environment. Here, we have set this to 'pynn_env'.
88		-
89	89	(% class="box infomessage" %)
90	90	(((
91	91	**Screencast** - terminal
92		-
93		-(% style="color:#000000" %)
94		-python3 -m venv pynn_env
	87	+\\(% style="color:#000000" %)python3 -m venv pynn_env
95	95	)))
96	96
97	97	(% class="box warningmessage" %)
...	...	@@ -130,18 +130,8 @@
130	130	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.
131	131	)))
132	132
133		-Before we proceed, let us run the following commands to ensure that our environment is setup as required:
	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.
134	134
135		-
136		-(% class="box infomessage" %)
137		-(((
138		-**Screencast** - terminal
139		-\\(% style="color:#000000" %)pip install ~-~-upgrade pip
140		-sudo apt install make
141		-)))
142		-
143		-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.
144		-
145	145	(% class="box errormessage" %)
146	146	(((
147	147	**Note:**
...	...	@@ -185,7 +185,7 @@
185	185
186	186	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.
187	187
188		-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.
189	189
190	190	(% class="box infomessage" %)
191	191	(((
...	...	@@ -201,11 +201,9 @@
201	201	(((
202	202	**Screencast** - terminal
203	203	\\(% style="color:#000000" %)nest
204		-
205		-(% style="color:#000000" %)exit
206	206	)))
207	207
208		-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.
209	209
210	210	(% class="box infomessage" %)
211	211	(((
...	...	@@ -223,7 +223,7 @@
223	223
224	224	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.
225	225
226		-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.
227	227
228	228	(% class="box infomessage" %)
229	229	(((
...	...	@@ -280,7 +280,7 @@
280	280	(% style="color:#000000" %)sim.end()
281	281	)))
282	282
283		-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:
284	284
285	285	(% class="box infomessage" %)
286	286	(((
...	...	@@ -304,14 +304,6 @@
304	304
305	305	This confirms that all the required software packages have been successfully completed and are functioning as expected.
306	306
307		-As a last step, we will install a Python package named 'matplotlib' that would come in handy in the tutorials ahead.
308		-
309		-(% class="box infomessage" %)
310		-(((
311		-**Screencast** - terminal
312		-\\(% style="color:#000000" %)pip install matplotlib
313		-)))
314		-
315	315	(% class="box successmessage" %)
316	316	(((
317	317	**Slide** recap of learning objectives