merge

Author: Christian-B

.github/workflows/c_actions.yml

@@ -25,11 +25,11 @@ jobs:
     - name: Prepare
       uses: SpiNNakerManchester/SupportScripts/actions/prepare@main
       with:
-        checkout_dependencies: spinnaker_tools spinn_common SpiNNFrontEndCommon
-        install_dependencies: SpiNNUtils
-        install_module: false
-        install_check_tools: false
-        ubuntu_packages: doxygen gcc-arm-none-eabi
+        checkout-dependencies: spinnaker_tools spinn_common SpiNNFrontEndCommon
+        install-dependencies: SpiNNUtils
+        install-module: false
+        install-check-tools: false
+        ubuntu-packages: doxygen gcc-arm-none-eabi
 
     - name: Set environment variables
       run: |
@@ -103,13 +103,13 @@ jobs:
     - name: Prepare
       uses: SpiNNakerManchester/SupportScripts/actions/prepare@main
       with:
-        install_dependencies: > 
+        install-dependencies: > 
           SpiNNUtils SpiNNMachine SpiNNMan PACMAN spalloc
           SpiNNFrontEndCommon TestBase
-        install_module: true
-        install_check_tools: false
-        ubuntu_packages: graphviz
-        cfg_file: spynnaker
+        install-module: true
+        install-check-tools: false
+        ubuntu-packages: graphviz
+        cfg-file: spynnaker
 
     - name: Download Fec binaries
       uses: actions/download-artifact@v4

.github/workflows/publish.yml

@@ -42,7 +42,7 @@ jobs:
           echo "NEURAL_MODELLING_DIRS=$PWD/neural_modelling" >> $GITHUB_ENV
 
       - name: Checkout SpiNNaker Dependencies
-        uses: ./support/actions/install-spinn-deps
+        uses: SpiNNakerManchester/SupportScripts/actions/install-spinn-deps@main
         with:
           repositories: >
             spinnaker_tools

.github/workflows/python_actions.yml

@@ -27,10 +27,11 @@ jobs:
     uses: SpiNNakerManchester/SupportScripts/.github/workflows/python_checks.yml@main
     with:
       dependencies: SpiNNUtils SpiNNMachine SpiNNMan PACMAN spalloc SpiNNFrontEndCommon TestBase
-      ubuntu_packages: graphviz
-      test_directories: unittests
+      ubuntu-packages: graphviz
+      test-directories: unittests
       coverage-package: spynnaker
       flake8-packages: spynnaker unittests spynnaker_integration_tests proxy_integration_tests
       pylint-packages: spynnaker
-      mypy-packages: spynnaker unittests spynnaker_integration_tests proxy_integration_tests
-      cfg_file: spynnaker
+      mypy-packages: proxy_integration_tests
+      mypy-full-packages: spynnaker unittests spynnaker_integration_tests
+      cfg-file: spynnaker

.readthedocs.yml

@@ -17,6 +17,11 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+  jobs:
+    post_build:
+      - cd neural_modelling; doxygen ./Doxyfile
+      - mkdir -p ${READTHEDOCS_OUTPUT}html/neural_modelling/
+      - cp -a neural_modelling/html/* ${READTHEDOCS_OUTPUT}html/neural_modelling/
 sphinx:
   configuration: doc/source/conf.py
   builder: dirhtml

doc/source/conf.py

@@ -93,16 +93,16 @@
 
 # General information about the project.
 project = 'sPyNNaker'
-copyright = '2014'
+copyright = '%Y The University of Manchester'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '6.0'
+version = 'development'
 # The full version, including alpha/beta/rc tags.
-release = '6.0.1'
+release = 'development'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/source/index.rst

@@ -1,6 +1,8 @@
 These pages document the python code for the sPyNNaker_ module
 which is part of the SpiNNaker_ Project.
 
+The neural_modelling_ module contains the documentation of the C code for this module.
+
 This code depends on SpiNNUtils_, SpiNNMachine_, SpiNNMan_, PACMAN_, SpiNNFrontEndCommon_
 (Combined_documentation_).
 
@@ -12,6 +14,7 @@ This code depends on SpiNNUtils_, SpiNNMachine_, SpiNNMan_, PACMAN_, SpiNNFrontE
 .. _PACMAN: https://pacman.readthedocs.io
 .. _SpiNNFrontEndCommon: https://spinnfrontendcommon.readthedocs.io
 .. _Combined_documentation: https://spinnakermanchester.readthedocs.io
+.. _neural_modelling: neural_modelling/
 
 sPyNNaker
 =========

mypy.bash

@@ -25,5 +25,6 @@ man="../SpiNNMan/spinnman"
 pacman="../PACMAN/pacman"
 spalloc="../spalloc/spalloc_client"
 fec="../SpiNNFrontEndCommon/spinn_front_end_common"
+test_base="../TestBase/spinnaker_testbase"
 
-mypy --python-version 3.8 $utils $machine $man $pacman $spalloc $fec spynnaker
+mypy --python-version 3.8 $utils $machine $man $pacman $spalloc $fec $test_base spynnaker unittests spynnaker_integration_tests

mypyd.bash

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# Copyright (c) 2024 The University of Manchester
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This bash assumes that other repositories are installed in paralled
+
+# requires the latest mypy
+# pip install --upgrade mypy
+
+utils="../SpiNNUtils/spinn_utilities"
+machine="../SpiNNMachine/spinn_machine"
+man="../SpiNNMan/spinnman"
+pacman="../PACMAN/pacman"
+spalloc="../spalloc/spalloc_client"
+fec="../SpiNNFrontEndCommon/spinn_front_end_common"
+test_base="../TestBase/spinnaker_testbase"
+
+mypy --python-version 3.8 --disallow-untyped-defs $utils $machine $man $pacman $spalloc $fec $test_base spynnaker unittests spynnaker_integration_tests
+

neural_modelling/Doxyfile

@@ -52,7 +52,7 @@ PROJECT_NAME           = "sPyNNaker neural_modelling"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 7.3.1
+PROJECT_NUMBER         = development
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

neural_modelling/mainpage.dox

@@ -59,8 +59,6 @@
 *
 * These enable the neuron simulation to work, or to work more efficiently.
 *
-* * Bitfield Expander, which builds inter-core message masks on the machine.
-*   See bit_field_expander.c
 * * Delay Extension, which handles messages that need to be delayed a long time
 *   before delivery. See delay_extension.c
 * * Robot Motor Control, which translates spiking rates of SpiNNaker messages