Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions doc/htmldoc/installation/developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,23 @@ Install NEST from source
We have provided an `environment.yml <https://github.com/nest/nest-simulator/blob/master/environment.yml>`_
file that contains all possible packages needed for NEST development.

.. grid:: 2
.. grid:: 3

.. grid-item-card:: Install NEST with venv
:link: venv
:link-type: ref


.. grid-item-card:: Install NEST with mamba
:link: condaenv
:link-type: ref

See our instructions for installing NEST from source in a :ref:`mamba environment <condaenv>`

.. grid-item-card:: Install NEST without environment
:link: noenv
:link-type: ref


If you want to install NEST without any environment, see the :ref:`instructions here <noenv>`.


.. seealso::
Expand Down
16 changes: 12 additions & 4 deletions doc/htmldoc/installation/noenv_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ further adjust settings for your system.
libgsl-dev \
libboost-dev \
cython3 \
libreadline-dev \
python3-all-dev \
python3-numpy \
python3-scipy \
Expand All @@ -36,13 +35,22 @@ further adjust settings for your system.
openmpi-bin \
libopenmpi-dev \
python3-mpi4py \
libmusic-dev \
music-bin \
python3-pip \
python3-pytest \
python3-pytest-timeout \
python3-pytest-xdist \
python3-pandas
python3-pandas \
pandoc

* Optional packages

.. code-block:: bash

# for SONATA compatiblity
libhdf5-dev
# for MUSIC compatibility
libmusic-dev \
music-bin

* Create an install directory

Expand Down
90 changes: 90 additions & 0 deletions doc/htmldoc/installation/venv_install.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
.. _venv:

Install from source in a ``venv`` environment
=============================================

* Create and activate a ``venv`` environment:

.. code-block:: bash

python -m venv nest_venv
source nest_venv/bin/activate


* Install base packages on your system:

.. code-block:: bash

sudo apt install \
cmake \
libltdl-dev \
libboost-filesystem-dev \
libboost-regex-dev \
libboost-wave-dev \
libboost-python-dev \
libboost-program-options-dev \
libboost-test-dev \
openmpi-bin \
libopenmpi-dev \
libgsl0-dev \
pandoc

* Optional packages

.. code-block:: bash

# for SONATA compatiblity
libhdf5-dev
# for MUSIC compatibility
libmusic-dev \
music-bin

* Install Python packages (see `requirements.txt <https://github.com/nest/nest-simulator/blob/master/requirements.txt>`_ for details):

.. code-block:: bash

pip install -r requirements.txt # installs all dependencies for PyNEST, testing, docs, and nest-server


* Create a build directory:

.. code-block:: bash

mkdir build_dir # Build directory should be placed outside of source repository

* Change to the build directory:

.. code-block:: bash

cd build_dir


* Build NEST:

You may need additional ``cmake`` options (see :ref:`cmake_options`).

.. code-block:: bash

cmake </path/to/NEST/src>

* Compile and install NEST:

.. code-block:: bash

make
make install
make installcheck

For your convenience, a shell script setting all required environment variables is provided in
``<nest_install_dir>/bin/nest_vars.sh``. Setting the environment variables in your active shell session requires
sourcing the script:

.. code-block:: bash

source <nest_install_dir>/bin/nest_vars.sh



.. note::

To build the developer or user documentation see :ref:`doc_workflow`
Loading