Merge pull request #24 from clinssen/fix-3.6

Author: clinssen

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
             os: ubuntu-latest
           - cpp_compiler: "gcc"
             os: macos-latest
-  
+
     steps:
       # Checkout the repository
       - name: Checkout nest-extension-module code
@@ -40,7 +40,7 @@ jobs:
         if: runner.os == 'macOS'
         run: |
           brew install coreutils gsl open-mpi automake autoconf libtool
-      
+
       # Install python dependencies
       - name: Install Python dependencies
         run: |
@@ -50,6 +50,60 @@ jobs:
       # Run the build script
       - name: Build script
         run: |
-          chmod +x build.sh
-          set -o pipefail
-          ./build.sh
+          # We need to do this, because  update-alternatives is not available on MacOS
+          if [ "$xNEST_BUILD_COMPILER" = "CLANG" ]; then
+              export CC=clang-11
+              export CXX=clang++-11
+          fi
+
+          if [ "$(uname -s)" = 'Linux' ]; then
+              CONFIGURE_MPI="-Dwith-mpi=ON"
+              CONFIGURE_OPENMP="-Dwith-openmp=ON"
+          else
+              CONFIGURE_MPI="-Dwith-mpi=OFF"
+              CONFIGURE_OPENMP="-Dwith-openmp=OFF"
+          fi
+
+          SOURCEDIR=$PWD
+          echo "SOURCEDIR = $SOURCEDIR"
+          cd ..
+
+          # Install current NEST version.
+          git clone https://github.com/nest/nest-simulator.git
+          cd nest-simulator
+
+          # Explicitly allow MPI oversubscription. This is required by Open MPI versions > 3.0.
+          # Not having this in place leads to a "not enough slots available" error.
+          NEST_RESULT=result
+          if [ "$(uname -s)" = 'Linux' ]; then
+              NEST_RESULT=$(readlink -f $NEST_RESULT)
+          else
+              NEST_RESULT=$(greadlink -f $NEST_RESULT)
+          fi
+          mkdir "$NEST_RESULT"
+          echo "NEST_RESULT = $NEST_RESULT"
+          mkdir build && cd build
+          cmake \
+              -Dwith-optimize=ON -Dwith-warning=ON \
+              $CONFIGURE_MPI \
+              $CONFIGURE_OPENMP \
+              -DCMAKE_INSTALL_PREFIX=$NEST_RESULT\
+              ..
+
+          VERBOSE=1 make -j 2
+          make install
+
+          cd $SOURCEDIR
+          mkdir build && cd build
+          cmake \
+              -Dwith-optimize=ON -Dwith-warning=ON \
+              -Dwith-nest=$NEST_RESULT/bin/nest-config \
+              $CONFIGURE_MPI \
+              $CONFIGURE_OPENMP \
+              ..
+
+          VERBOSE=1 make -j 2
+          make install
+
+          . $NEST_RESULT/bin/nest_vars.sh
+          python -c 'import nest; nest.Install("mymodule")'

README.rst

@@ -1,49 +1,32 @@
 NEST Extension Module Example
 =============================
 
-.. attention::
-
-   This version of the extension module code will not work with NEST
-   3.6 or earlier. It is adapted to NEST Master as of 15 December 2023.
-
 This repository contains an example extension module (i.e a "plugin") for
 the `NEST Simulator <https://nest-simulator.org>`_. Extension modules allow
-users to extend the functionality of NEST without messing with the source
+users to extend the functionality of NEST without altering the source
 code of NEST itself, thus making pulls from upstream easy, while allowing
 to extend NEST and sharing the extensions with other researchers.
 
-In order to showcase the possibilites of extension modules and their use,
-this extension module example contains the following (intentionally simple
-and more or less silly) custom example components:
-
-* A **neuron model** called ``pif_psc_alpha``, which implements a
-  *non*-leaky integrate-and-fire model with alpha-function shaped
-  post-synaptic potentials.
-* A **synapse model** called ``drop_odd_spike_connection``, which drops
-  all spikes that arrive at odd-numbered points on the simulation time
-  grid and delivers only those arriving at even-numbered grid points.
-* A **connection builder** called ``step_pattern_builder``, which
-  creates step-pattern connectivity between the neurons of a source
-  and a target population.
-* A **recording backend** called ``RecordingBackendSocket``, which
-  streams out the data from spike recorders to an external (or local)
-  server via UDP.
-* A **recording backend** called ``RecordingBackendSoundClick``, which
-  creates the illusion of a realistic sound from an electrophysiological
-  spike recording device.
-
-For a list of modules developed by other users you can check out the
-`list of forks <https://github.com/nest/nest-extension-module/network/members>`_
-of this repository.
-
-Adapting ``MyModule``
----------------------
-
-If you want to create your own custom extension module using MyModule
-as a start, you have to perform the following steps:
-
-1. Replace all occurences of the strings ``MyModule``, ``mymodule``
-   and ``my`` by something more descriptive and appropriate for your
-   module.
-2. Remove the example functionality you do not need.
-3. Adapt the example functionality you do need to your needs.
+For the full documentation of this feature and further instructions, please see
+https://nest-extension-module.readthedocs.io/.
+
+.. attention::
+
+   Please note that the code in this repository will not work with NEST
+   versions earlier than NEST 3.10. The extension module is generally
+   kept adapted and up-to-date with the NEST ``master`` branch on
+   https://github.com/nest/nest-simulator as well as the latest
+   NEST release (starting from NEST 3.10).
+
+   For extension modules that support older versions of NEST, please browse
+   the history of this repository. For support for 2.x versions of NEST, see
+   the extension module example in ``examples/MyModule`` of the source
+   distribution.
+
+
+License
+-------
+
+NEST is open source software and is licensed under the `GNU General Public
+License v2 <https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>`_ or
+later.

build.sh

@@ -177,5 +177,3 @@ def setup(app):
     (master_doc, 'NESTextmod.tex', u'NEST Simulator extension module documentation',
      u'NEST Developer Community', 'manual'),
 ]
-
-copyfile('../README.rst', 'README.rst')