Skip to content

Commit

Permalink
Merge pull request #3037 from steffengraber/add-nestmldoc
Browse files Browse the repository at this point in the history
Add brief install instructions for the NESTML package in our ppa
  • Loading branch information
jessica-mitchell authored Dec 6, 2023
2 parents 02037ab + 57d23a9 commit 12cff3d
Showing 1 changed file with 6 additions and 60 deletions.
66 changes: 6 additions & 60 deletions doc/htmldoc/installation/user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,75 +50,21 @@ Ubuntu users can install NEST via the PPA repository.
sudo apt-get install nest
Debian
~~~~~~

Debian users can install NEST via the Ubuntu PPA repository.

1. Create a new ``apt`` repository entry in ``/etc/apt/sources.list.d/nest-simulator-ubuntu-nest-XXX.list`` by:

.. code-block:: bash
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:
Or install NEST with `NESTML <https://nestml.readthedocs.io/en/latest/index.html>`_

.. 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
sudo apt install nest python3-nestml
python3 -m pip install --upgrade odetoolbox pygsl antlr4-python3-runtime==4.10
3. Import the PPA GPC key and rebuild the package:
3. Set the environment

.. code-block:: bash
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.
In addition, install:

.. code-block:: bash
source /usr/bin/nest_vars.sh
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:

.. 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
sudo dpkg --install nest-simulator-x.y.z~NUMBER~ubuntu20.04.1_amd64.deb
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
python3
import nest
--------

-------------

macOS |macos|
-------------
Expand Down

0 comments on commit 12cff3d

Please sign in to comment.