From 9a00a7cb19e582e8096ef3fc5a29c3bb60dd71b0 Mon Sep 17 00:00:00 2001 From: sarakonradi Date: Mon, 27 Jan 2020 15:27:41 +0100 Subject: [PATCH 01/12] Update Debian installation instructions --- doc/installation/index.rst | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index 59e926ddcf..42d5f5436d 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -15,18 +15,38 @@ compile NEST from source, see section** :ref:`advanced_install`. Install NEST via the PPA repository. - 1. Add the PPA repository for NEST and update apt: + 1. Create a new ``apt`` repository entry in ``/etc/apt/sources.list.d/pogo-dev-ubuntu-stable-disco.list`` by: .. code-block:: bash - sudo add-apt-repository ppa:nest-simulator/nest - sudo apt-get update + sudo apt install devscripts build-essential software-properties-common dpkg-dev + sudo add-apt-repository --enable-source ppa:nest-simulator/nest - 2. Install NEST: + 2. Disable the the binary package in the repository file by commenting it out. + + 3. Import the PPA GPC key and rebuild the package: + + .. code-block:: bash + + sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys CF7539642ABD23CBCA8D487F0B8B6C5EC02D7DD + sudo apt update + sudo apt source --build nest + + 4. Install any missing dependencies, if apt tells you so. + + 5. Install the ready Debian package after the rebuild: + + .. code-block:: bash + + sudo dpkg --install nest_2.18.0-0~201911260924~ubuntu20.04.1_amd64.deb + + 6. Test the package: .. code-block:: bash - sudo apt-get install nest + python3 + import nest + .. tab:: NeuroFedora From 97972864bf4dc391f78d74fe9f78e3cc51914599 Mon Sep 17 00:00:00 2001 From: sarakonradi Date: Tue, 28 Jan 2020 09:40:55 +0100 Subject: [PATCH 02/12] Include Ubuntu and Debian installation instructions --- doc/installation/index.rst | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index 42d5f5436d..feff15601b 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -11,9 +11,24 @@ compile NEST from source, see section** :ref:`advanced_install`. .. tabs:: - .. tab:: Debian/Ubuntu PPA + .. tab:: Ubuntu PPA (Debian) - Install NEST via the PPA repository. + **Ubuntu users can install NEST via the PPA repository.** + + 1. Add the PPA repository for NEST and update apt: + + .. code-block:: bash + + sudo add-apt-repository ppa:nest-simulator/nest + sudo apt-get update + + 2. Install NEST: + + .. code-block:: bash + + sudo apt-get install nest + + **Debian users may install NEST via the Ubuntu PPA repository.** 1. Create a new ``apt`` repository entry in ``/etc/apt/sources.list.d/pogo-dev-ubuntu-stable-disco.list`` by: @@ -38,7 +53,7 @@ compile NEST from source, see section** :ref:`advanced_install`. .. code-block:: bash - sudo dpkg --install nest_2.18.0-0~201911260924~ubuntu20.04.1_amd64.deb + sudo dpkg --install nest-simulator-x.y.z~NUMBER~ubuntu20.04.1_amd64.deb 6. Test the package: From 13f32ea654a991ed3f6a95d554cda98001d88817 Mon Sep 17 00:00:00 2001 From: sarakonradi Date: Tue, 28 Jan 2020 12:06:09 +0100 Subject: [PATCH 03/12] Separate Ubuntu and Debian tabs --- doc/installation/index.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index feff15601b..df98f936f6 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -11,9 +11,9 @@ compile NEST from source, see section** :ref:`advanced_install`. .. tabs:: - .. tab:: Ubuntu PPA (Debian) + .. tab:: Ubuntu - **Ubuntu users can install NEST via the PPA repository.** + Ubuntu users can install NEST via the PPA repository. 1. Add the PPA repository for NEST and update apt: @@ -28,7 +28,10 @@ compile NEST from source, see section** :ref:`advanced_install`. sudo apt-get install nest - **Debian users may install NEST via the Ubuntu PPA repository.** + + .. tab:: Debian + + Debian users can install NEST via the Ubuntu PPA repository. 1. Create a new ``apt`` repository entry in ``/etc/apt/sources.list.d/pogo-dev-ubuntu-stable-disco.list`` by: @@ -37,7 +40,7 @@ compile NEST from source, see section** :ref:`advanced_install`. sudo apt install devscripts build-essential software-properties-common dpkg-dev sudo add-apt-repository --enable-source ppa:nest-simulator/nest - 2. Disable the the binary package in the repository file by commenting it out. + 2. Disable the binary package in the repository file by commenting it out. 3. Import the PPA GPC key and rebuild the package: From 0e92865276e842626feedce1f1bb833522f3c2ee Mon Sep 17 00:00:00 2001 From: sarakonradi Date: Tue, 28 Jan 2020 12:34:02 +0100 Subject: [PATCH 04/12] Add backslash --- doc/installation/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index df98f936f6..57104159f1 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -46,7 +46,8 @@ compile NEST from source, see section** :ref:`advanced_install`. .. code-block:: bash - sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys CF7539642ABD23CBCA8D487F0B8B6C5EC02D7DD + sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 \ + --recv-keys CF7539642ABD23CBCA8D487F0B8B6C5EC02D7DD sudo apt update sudo apt source --build nest From 1ba8b2ac0c6663d0704c5c37e3307bf6a2becaa9 Mon Sep 17 00:00:00 2001 From: sarakonradi Date: Tue, 28 Jan 2020 12:37:12 +0100 Subject: [PATCH 05/12] Update Debian instructions --- doc/installation/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index 57104159f1..c751642c00 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -51,7 +51,7 @@ compile NEST from source, see section** :ref:`advanced_install`. sudo apt update sudo apt source --build nest - 4. Install any missing dependencies, if apt tells you so. + 4. Install any missing dependencies, if ``apt`` tells you so. 5. Install the ready Debian package after the rebuild: From 3e23c1f201a1bd9ffe357b01c166fd8779aa4191 Mon Sep 17 00:00:00 2001 From: sarakonradi Date: Mon, 10 Feb 2020 13:53:58 +0100 Subject: [PATCH 06/12] Add suggested changes --- doc/installation/index.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index c751642c00..b62eea80a2 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -33,7 +33,7 @@ compile NEST from source, see section** :ref:`advanced_install`. Debian users can install NEST via the Ubuntu PPA repository. - 1. Create a new ``apt`` repository entry in ``/etc/apt/sources.list.d/pogo-dev-ubuntu-stable-disco.list`` by: + 1. Create a new ``apt`` repository entry in ``/etc/apt/sources.list.d/nest-simulator-ubuntu-nest-XXX.list`` by: .. code-block:: bash @@ -47,19 +47,21 @@ compile NEST from source, see section** :ref:`advanced_install`. .. code-block:: bash sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 \ - --recv-keys CF7539642ABD23CBCA8D487F0B8B6C5EC02D7DD + --recv-keys 0CF7539642ABD23CBCA8D487F0B8B6C5EC02D7DD sudo apt update sudo apt source --build nest 4. Install any missing dependencies, if ``apt`` tells you so. - 5. Install the ready Debian package after the rebuild: + 5. After installing the dependencies, enter ``sudo apt source --build nest`` again. + + 6. Install the ready Debian package after the rebuild: .. code-block:: bash sudo dpkg --install nest-simulator-x.y.z~NUMBER~ubuntu20.04.1_amd64.deb - 6. Test the package: + 7. Test the package: .. code-block:: bash From 85edc29117ec36b70c965631953b8587a0b29b41 Mon Sep 17 00:00:00 2001 From: sarakonradi <58212853+sarakonradi@users.noreply.github.com> Date: Tue, 21 Apr 2020 16:51:59 +0200 Subject: [PATCH 07/12] Update doc/installation/index.rst, as suggested by @terhorstd Co-Authored-By: terhorstd --- doc/installation/index.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index b62eea80a2..c7529fc736 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -40,7 +40,15 @@ compile NEST from source, see section** :ref:`advanced_install`. sudo apt install devscripts build-essential software-properties-common dpkg-dev sudo add-apt-repository --enable-source ppa:nest-simulator/nest - 2. Disable the binary package in the repository file by commenting it out. + 2. Disable the binary package in the repository file created under + ``/etc/apt/sources.list.d/`` by commenting out the ``deb`` line, while + keeping the ``deb-src`` line. It should look similar to this: + + .. code-block:: bash + + #deb http://ppa.launchpad.net/nest-simulator/nest/ubuntu focal main + deb-src http://ppa.launchpad.net/nest-simulator/nest/ubuntu focal main + 3. Import the PPA GPC key and rebuild the package: @@ -307,4 +315,3 @@ these instructions.** Installation instructions for NEST 2.10 and earlier are provided :doc:`here `, but we strongly encourage all our users to stay up-to-date with most recent version of NEST. We cannot support out-dated versions. - From f594dc250f4b351824b7bde64b2c0b1039346e2a Mon Sep 17 00:00:00 2001 From: graber Date: Thu, 25 Jun 2020 13:41:36 +0200 Subject: [PATCH 08/12] Update doc/installation/index.rst Co-authored-by: terhorstd --- doc/installation/index.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index 6f380b2095..8446a8c420 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -62,6 +62,18 @@ compile NEST from source, see section** :ref:`advanced_install`. 4. Install any missing dependencies, if ``apt`` tells you so. 5. After installing the dependencies, enter ``sudo apt source --build nest`` again. + When the build finished, look for lines like + ``` + dpkg-deb: building package 'nest-dbgsym' in '../nest-dbgsym_2.20.0-0~202001311135~ubuntu20.04.1_amd64.deb'. + dpkg-deb: building package 'nest' in '../nest_2.20.0-0~202001311135~ubuntu20.04.1_amd64.deb'. + #dh binary + dpkg-genbuildinfo --build=binary + dpkg-genchanges --build=binary >../nest_2.20.0-0~202001311135~ubuntu20.04.1_amd64.changes + ``` + and note down the full package name. In the above example this would be + `nest_2.20.0-0~202001311135~ubuntu20.04.1_amd64.deb`, where the + number `202001311135` and potentially the Ubuntu version number may + be different. 6. Install the ready Debian package after the rebuild: @@ -314,4 +326,3 @@ these instructions.** Installation instructions for NEST 2.10 and earlier are provided :doc:`here `, but we strongly encourage all our users to stay up-to-date with most recent version of NEST. We cannot support out-dated versions. - From 9066c40285fc9e36d7a40e4c5a35b3169743237d Mon Sep 17 00:00:00 2001 From: graber Date: Thu, 25 Jun 2020 13:42:02 +0200 Subject: [PATCH 09/12] Update doc/installation/index.rst Co-authored-by: terhorstd --- doc/installation/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index 8446a8c420..ae43e81b97 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -81,6 +81,9 @@ compile NEST from source, see section** :ref:`advanced_install`. sudo dpkg --install nest-simulator-x.y.z~NUMBER~ubuntu20.04.1_amd64.deb + Where the package name is taken from the result of the previous step (`NUMBER` + and potentially the Ubuntu version might differ). + 7. Test the package: .. code-block:: bash From 870ea4f3d3dce5a8ac3a95c43164bf6254f934d4 Mon Sep 17 00:00:00 2001 From: Steffen Date: Thu, 25 Jun 2020 14:06:43 +0200 Subject: [PATCH 10/12] Formatting --- doc/installation/index.rst | 68 +++++++++++++++++++------------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index ae43e81b97..43b6871db8 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -35,61 +35,61 @@ compile NEST from source, see section** :ref:`advanced_install`. 1. Create a new ``apt`` repository entry in ``/etc/apt/sources.list.d/nest-simulator-ubuntu-nest-XXX.list`` by: - .. code-block:: bash + .. code-block:: bash - sudo apt install devscripts build-essential software-properties-common dpkg-dev - sudo add-apt-repository --enable-source ppa:nest-simulator/nest + sudo apt install devscripts build-essential software-properties-common dpkg-dev + sudo add-apt-repository --enable-source ppa:nest-simulator/nest - 2. Disable the binary package in the repository file created under - ``/etc/apt/sources.list.d/`` by commenting out the ``deb`` line, while - keeping the ``deb-src`` line. It should look similar to this: + 2. Disable the binary package in the repository file created under ``/etc/apt/sources.list.d/`` by commenting + out the ``deb`` line, while keeping the ``deb-src`` line. It should look similar to this: - .. code-block:: bash + .. code-block:: bash - #deb http://ppa.launchpad.net/nest-simulator/nest/ubuntu focal main - deb-src http://ppa.launchpad.net/nest-simulator/nest/ubuntu focal main + #deb http://ppa.launchpad.net/nest-simulator/nest/ubuntu focal main + deb-src http://ppa.launchpad.net/nest-simulator/nest/ubuntu focal main 3. Import the PPA GPC key and rebuild the package: - .. code-block:: bash + .. code-block:: bash - sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 \ - --recv-keys 0CF7539642ABD23CBCA8D487F0B8B6C5EC02D7DD - sudo apt update - sudo apt source --build nest + sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 \ + --recv-keys 0CF7539642ABD23CBCA8D487F0B8B6C5EC02D7DD + sudo apt update + sudo apt source --build nest 4. Install any missing dependencies, if ``apt`` tells you so. 5. After installing the dependencies, enter ``sudo apt source --build nest`` again. - When the build finished, look for lines like - ``` - dpkg-deb: building package 'nest-dbgsym' in '../nest-dbgsym_2.20.0-0~202001311135~ubuntu20.04.1_amd64.deb'. - dpkg-deb: building package 'nest' in '../nest_2.20.0-0~202001311135~ubuntu20.04.1_amd64.deb'. - #dh binary - dpkg-genbuildinfo --build=binary - dpkg-genchanges --build=binary >../nest_2.20.0-0~202001311135~ubuntu20.04.1_amd64.changes - ``` - and note down the full package name. In the above example this would be - `nest_2.20.0-0~202001311135~ubuntu20.04.1_amd64.deb`, where the - number `202001311135` and potentially the Ubuntu version number may - be different. + When the build finished, look for lines like + + .. code-block:: bash + + dpkg-deb: building package 'nest-dbgsym' in '../nest-dbgsym_2.20.0-0~202001311135~ubuntu20.04.1_amd64.deb'. + dpkg-deb: building package 'nest' in '../nest_2.20.0-0~202001311135~ubuntu20.04.1_amd64.deb'. + #dh binary + dpkg-genbuildinfo --build=binary + dpkg-genchanges --build=binary >../nest_2.20.0-0~202001311135~ubuntu20.04.1_amd64.changes + + and note down the full package name. In the above example this would be + `nest_2.20.0-0~202001311135~ubuntu20.04.1_amd64.deb`, where the number `202001311135` and potentially the + Ubuntu version number may be different. 6. Install the ready Debian package after the rebuild: - .. code-block:: bash + .. code-block:: bash - sudo dpkg --install nest-simulator-x.y.z~NUMBER~ubuntu20.04.1_amd64.deb + sudo dpkg --install nest-simulator-x.y.z~NUMBER~ubuntu20.04.1_amd64.deb - Where the package name is taken from the result of the previous step (`NUMBER` - and potentially the Ubuntu version might differ). + Where the package name is taken from the result of the previous step (`NUMBER` and potentially the Ubuntu + version might differ). 7. Test the package: - .. code-block:: bash + .. code-block:: bash - python3 - import nest + python3 + import nest .. tab:: NeuroFedora @@ -115,7 +115,7 @@ compile NEST from source, see section** :ref:`advanced_install`. .. pull-quote:: - We strongly recommend that you **install all programs** + We strongly recommend that you **install all programs** you'll need, (such as ``ipython`` or ``jupyter-lab``) in the environment (ENVNAME) **at the same time**, by **appending them to the command below**. From 9925beae36a65cad53e1bce7e628105c3ef37dc1 Mon Sep 17 00:00:00 2001 From: Steffen Date: Thu, 25 Jun 2020 14:15:12 +0200 Subject: [PATCH 11/12] Added missing dependencies --- doc/installation/index.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index 43b6871db8..d5c103f05d 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -59,6 +59,11 @@ compile NEST from source, see section** :ref:`advanced_install`. sudo apt source --build nest 4. Install any missing dependencies, if ``apt`` tells you so. + In addition install: + + .. code-block:: bash + + sudo apt install python3-all dh-python 5. After installing the dependencies, enter ``sudo apt source --build nest`` again. When the build finished, look for lines like From 41577c376633f9e89b9d1d679dd7671067a4d6c2 Mon Sep 17 00:00:00 2001 From: Sara Konradi Date: Thu, 25 Jun 2020 14:39:05 +0200 Subject: [PATCH 12/12] Update punctuation --- doc/installation/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/installation/index.rst b/doc/installation/index.rst index d5c103f05d..9db9156602 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -59,7 +59,7 @@ compile NEST from source, see section** :ref:`advanced_install`. sudo apt source --build nest 4. Install any missing dependencies, if ``apt`` tells you so. - In addition install: + In addition, install: .. code-block:: bash @@ -86,8 +86,8 @@ compile NEST from source, see section** :ref:`advanced_install`. sudo dpkg --install nest-simulator-x.y.z~NUMBER~ubuntu20.04.1_amd64.deb - Where the package name is taken from the result of the previous step (`NUMBER` and potentially the Ubuntu - version might differ). + The package name is taken from the result of the previous step. `NUMBER` and potentially the Ubuntu + version might differ. 7. Test the package: