Changes for page 02. Installing PyNN - Linux

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

From 10.1 to 9.1 From 39.1 to 38.1

From version 38.1

edited by annedevismes
on 2021/10/18 10:12

Change comment: There is no comment for this version

To version 10.1

edited by adavison
on 2021/08/03 18:30

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--02. Installing PyNN - Linux
++02. Installing PyNN

Author

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

Content

@@ -1,315 +90,66 @@
--== Learning objectives ==
--
--In this tutorial, you will learn how to install PyNN, together with the NEST, NEURON, and Brian 2 simulators, on Linux.
--
--(% class="box infomessage" %)
--(((
--Note: There will be a separate tutorial for each environment.
--)))
--
--== Audience ==
--
--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.
--
--== Prerequisites ==
--
--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.
--
--== Format ==
--
--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.
--
--== Script ==
--
--(% class="box successmessage" %)
--(((
--**Slide** showing tutorial title, PyNN logo, link to PyNN service page.
--)))
--
--Hello, my name is X.
--
--This video is one of a series of tutorials for PyNN, which is Python software for modelling and simulating spiking neural networks.
--
--For a list of the other tutorials in this series, you can visit ebrains.eu/service/pynn, that's p-y-n-n.
--
--(% class="box successmessage" %)
--(((
--**Slide** listing learning objectives
--)))
--
--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.
--
--(% class="box successmessage" %)
--(((
--**Slide** listing prerequisites
--)))
--
--I shall be demonstrating 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 will find on the Internet about how to carry out the equivalent of the tasks demonstrated here using Ubuntu OS. Also, the tutorial will focus 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.
--
--(% class="box errormessage" %)
--(((
--**Note**
--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.
--)))
--
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--)))
--
--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.
--
--We begin by creating a directory for our project.
--
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)cd ~~
--mkdir pynn_project
--cd pynn_project
--)))
--
--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.
--
--(% class="box errormessage" %)
--(((
--**Note**
--
--
--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:
--\\sudo apt-get install python3-venv
--\\More recent versions of Python 3 (e.g., v3.9) already have this pre-installed.
--)))
--
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)python3 -m venv pynn_env
--)))
--
  (% class="box warningmessage" %)
  (((
--**Note**
--
--
--Observe 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 shall keep things simple and try to work with the bare minimum changes to the system.
++tutorials under development for Linux, Mac OS, Windows, Jupyter Lab.
  )))
--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.
--(% class="box infomessage" %)
--(((
--**Screencast** - file explorer
--\\(% style="color:#000000" %)<< show directory contents; especially lib/python3.8/site-packages >>
--)))
++== Learning objectives ==
--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 will be reflected here.
++In this tutorial, you will learn how to install PyNN, together with the NEST, NEURON and Brian2 simulators, on Linux / Mac OS / Windows / in EBRAINS Jupyter Lab.
--To enter into 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:
--
  (% class="box infomessage" %)
  (((
--**Screencast** - terminal
--\\(% style="color:#000000" %)source pynn_env/bin/activate
++Note: There will be a separate tutorial for each environment.
  )))
--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.
++== Audience ==
--(% class="box warningmessage" %)
--(((
--**Note**
++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.
++== Prerequisites ==
--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.
--)))
++To follow this tutorial, you will need a computer with [Linux/Mac OS/Windows] and a good network connection. You will need to know how to open the terminal application for your operating system.
--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.
--(% class="box errormessage" %)
--(((
--**Note:**
--\\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:
--[[(% style="color:#000000" %)http:~~/~~/neuralensemble.org/docs/PyNN/installation.html>>http://neuralensemble.org/docs/PyNN/installation.html]]
--)))
++OR
--We start here with the installation of Brian 2. Brian 2 can be installed simply by using the pip command.
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)pip install brian2
--)))
++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.
--This will install Brian 2, along with all its dependencies such as 'cython', 'numpy', and so on. We can now go back into our virtual environment's 'site-packages' directory to see how it is now populated with all these packages.
++== Format ==
--(% class="box infomessage" %)
--(((
--**Screencast** - file explorer
--\\(% style="color:#000000" %)<< show directory contents lib/python3.8/site-packages >>
--)))
++These tutorials will be screencasts, in which the presenter runs commands in a terminal (or in a Jupyer notebook), and the viewer is expected to follow along. The intended duration is 10 minutes. For the Jupyter version of the tutorial, the final notebook will also be made available.
--To confirm that we have properly installed Brian 2 on our computer, we can test as follows:
++== Script ==
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)python
--\\import brian2
--\\exit()
--)))
++=== Introduce yourself (if video) ===
--(% class="box warningmessage" %)
--(((
--**Note:**
--\\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.
--)))
++.
--If there are no error messages here, and the import is successful, we have completed the installation of Brian 2.
++=== State the learning objectives (In this tutorial, you will learn to do X…) ===
--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.
++.
--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 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.
++=== State prerequisites ===
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)sudo add-apt-repository ppa:nest-simulator/nest
--sudo apt-get update
--\\sudo apt-get install nest
--)))
++.
--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:
++=== Description, explanation, and practice ===
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)nest
--)))
++.
--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.
++=== Summary (In this tutorial, you have learned to do X…) ===
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)python
--\\import nest
--\\exit()
--)))
++.
--(% class="box warningmessage" %)
--(((
--**Note**
--\\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.
--)))
++=== Acknowledgements if appropriate ===
--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.
++.
--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.
++=== References to websites (For more information, visit us at…) ===
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)pip install neuron
--)))
++.
--This installs the NEURON simulator on your system. To confirm that we have properly installed NEURON, we can test as follows:
++=== Contact information (For questions, contact us at…) ===
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)nrniv
--\\quit()
--)))
--
--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.
--
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)python
--\\from neuron import h
--\\exit()
--)))
--
--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.
--
--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:
--
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--\\(% style="color:#000000" %)pip install PyNN
--)))
--
--(% class="box warningmessage" %)
--(((
--**Note**
--\\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 shall 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'.
--)))
--
--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:
--
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--
--(% style="color:#000000" %)python
--\\import pyNN.brian2 as sim
--
--(% style="color:#000000" %)sim.setup()
--
--(% style="color:#000000" %)sim.end()
--)))
--
--This confirms that PyNN has been properly setup and also that is able to employ Brian 2. To verify similary that PyNN is also able to communicate with NEURON and NEST simulators, we can do the following:
--
--(% class="box infomessage" %)
--(((
--**Screencast** - terminal
--
--(% style="color:#000000" %)python
--\\import pyNN.nest as sim
--
--(% style="color:#000000" %)sim.setup()
--
--(% style="color:#000000" %)sim.end()
--
--
--
--(% style="color:#000000" %)import pyNN.neuron as sim
--
--(% style="color:#000000" %)sim.setup()
--
--(% style="color:#000000" %)sim.end()
--)))
--
--This confirms that all the required software packages have been successfully completed and are functioning as expected.
--
--(% class="box successmessage" %)
--(((
--**Slide** recap of learning objectives
--)))
--
--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 more advanced features of PyNN, so keep an eye on the EBRAINS website.
--
--(% class="box successmessage" %)
--(((
--**Slide** useful links
--\\[[(% style="color:#000000" %)https:~~/~~/realpython.com/python-virtual-environments-a-primer/>>https://realpython.com/python-virtual-environments-a-primer/]](%%)
--[[(% style="color:#000000" %)https:~~/~~/briansimulator.org/install/>>https://briansimulator.org/install/]](%%)
--[[(% 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]](%%)
--[[(% style="color:#000000" %)https:~~/~~/neuron.yale.edu/neuron/>>https://neuron.yale.edu/neuron/]]
--)))
--
--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.
--
--(% class="box successmessage" %)
--(((
--**Slide** acknowledgements, contact information
--)))
--
--(% class="wikigeneratedid" %)
--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.
--
--(% class="wikigeneratedid" %)
--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.
++.

Changes for page 02. Installing PyNN - Linux

Summary

Details

PyNN: resources