Merge pull request #76 from SpiNNakerManchester/citation_plus

Citation plus
SpiNNakerManchester · Mar 8, 2023 · 8976968 · 8976968
2 parents b7ed968 + dd54b9c
commit 8976968
Show file tree

Hide file tree

Showing 44 changed files with 131 additions and 86 deletions.
diff --git a/.github/workflows/python_actions.yml b/.github/workflows/python_actions.yml
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,
@@ -76,3 +76,7 @@ jobs:
       uses: ./support/actions/sphinx
       with:
         directory: docs/source
+
+    - name: Validate CITATION.cff
+      if: matrix.python-version == 3.8
+      uses: dieghernan/cff-validator@main
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/.pylintrc b/.pylintrc
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/CITATION.cff b/CITATION.cff
@@ -4,56 +4,97 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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.
 
+cff-version: 1.2.0
+message: If you use this software, please cite it as below.
+preferred-citation:
+  type: article
+  doi: 10.3389/fnins.2019.00231
+  issn: 1662-453X
+  url: https://www.frontiersin.org/articles/10.3389/fnins.2019.00231
+  title: "SpiNNTools: The Execution Engine for the SpiNNaker Platform"
+  journal: Frontiers in Neuroscience
+  volume: 13
+  year: 2019
+  month: 3
+  abstract: SpiNNaker is a massively parallel distributed architecture primarily focused on real time simulation of spiking neural networks. The largest realization of the architecture consists of one million general purpose processors, making it the largest neuromorphic computing platform in the world at the present time. Utilizing these processors efficiently requires expert knowledge of the architecture to generate executable code and to harness the potential of the unique inter-processor communications infra-structure that lies at the heart of the SpiNNaker architecture. This work introduces a software suite called SpiNNTools that can map a computational problem described as a graph into the required set of executables, application data and routing information necessary for simulation on this novel machine. The SpiNNaker architecture is highly scalable, giving rise to unique challenges in mapping the problem to the machines resources, loading the generated files to the machine and subsequently retrieving the results of simulation. In this paper we describe these challenges in detail and the solutions implemented.
+  authors:
+  - given-names: Andrew
+    family-names: Rowley
+    affiliation: University Of Manchester
+    email: Andrew.Rowley@manchester.ac.uk
+    orcid: https://orcid.org/0000-0002-2646-8520
+    website: https://www.researchgate.net/profile/Andrew_Rowley2
+  - given-names: Christian Y.
+    family-names: Brenninkmeijer
+    affiliation: University Of Manchester
+    email: christian.brenninkmeijer@manchester.ac.uk
+    orcid: https://orcid.org/0000-0002-2937-7819
+    website: https://www.researchgate.net/profile/Christian_Brenninkmeijer
+  - given-names: Simon
+    family-names: Davidson
+    affiliation: University Of Manchester
+    orcid: https://orcid.org/0000-0001-5385-442X
+    website: https://research.manchester.ac.uk/en/persons/simon.davidson
+  - given-names: Donal
+    family-names: Fellows
+    affiliation: University Of Manchester
+    orcid: https://orcid.org/0000-0002-9091-5938
+    website: https://www.researchgate.net/profile/Donal-Fellows
+  - given-names: Andrew
+    family-names: Gait
+    affiliation: University Of Manchester
+    orcid: https://orcid.org/0000-0001-9349-1096
+    website: https://personalpages.manchester.ac.uk/staff/andrew.gait/
+  - given-names: David R.
+    family-names: Lester
+    affiliation: University Of Manchester
+    orcid: https://orcid.org/0000-0002-7267-291X
+  - given-names: Luis A.
+    family-names: Plana
+    affiliation: University Of Manchester
+    orcid: https://orcid.org/0000-0002-6113-3929
+    website: https://research.manchester.ac.uk/en/persons/luis.plana
+  - given-names: Oliver
+    family-names: Rhodes
+    affiliation: University Of Manchester
+    orcid: https://orcid.org/0000-0003-1728-2828
+    website: https://research.manchester.ac.uk/en/persons/oliver.rhodes
+  - given-names: Alan B.
+    family-names: Stokes
+    affiliation: University Of Manchester
+    orcid: https://orcid.org/0000-0002-6110-1484
+    website: http://www.cs.man.ac.uk/~stokesa6/
+  - given-names: Steve B.
+    family-names: Furber
+    affiliation: University Of Manchester
+    orcid: https://orcid.org/0000-0002-6524-3367
+    website: https://research.manchester.ac.uk/en/persons/steve.furber
+
+title: The client side of the SpiNNaker machine allocation software
 authors:
-- affiliation: University Of Manchester
-  email: jheathcote@cs.man.ac.uk
-  family-names: Heathcote
-  given-names: Jonathan
-  website: http://apt.cs.manchester.ac.uk/people/jheathcote/
-- affiliation: University Of Manchester
-  email: christian.brenninkmeijer@manchester.ac.uk
-  family-names: Brenninkmeijer
-  given-names: Christian Y.
-  orcid: https://orcid.org/0000-0002-2937-7819
-  website: https://www.researchgate.net/profile/Christian_Brenninkmeijer
-- affiliation: University Of Manchester
-  email: donal.k.fellows@manchester.ac.uk
-  family-names: Fellows
-  given-names: Donal
-  orcid: https://orcid.org/0000-0002-9091-5938
-  website: http://www.cs.manchester.ac.uk/about-us/staff/profile/?ea=donal.k.fellows
-- affiliation: University Of Manchester
-  email: Andrew.Rowley@manchester.ac.uk
-  family-names: Rowley
-  given-names: Andrew
-  orcid: https://orcid.org/0000-0002-2646-8520
-  website: https://www.researchgate.net/profile/Andrew_Rowley2
-- affiliation: University Of Manchester
-  email: alan.stokes-2@manchester.ac.uk
-  family-names: Stokes
-  given-names: Alan
-  orcid: https://orcid.org/0000-0002-6110-1484
-  website: http://www.cs.man.ac.uk/~stokesa6/
-cff-version: 1.0.3
+    - name: SpiNNaker Software Team
+      alias: For a list of contributors see https://github.com/SpiNNakerManchester/spalloc/graphs/contributors or for a combined list see http://spinnakermanchester.github.io/latest/LicenseAgreement.html#contributors
+      address: University of Manchester, Oxford Road
+      city: Manchester
+      country: GB
+      email: spinnakerusers@googlegroups.com
+      post-code: M13 9PL
+      website: https://apt.cs.manchester.ac.uk/projects/SpiNNaker/
+url: http://spinnakermanchester.github.io/
 contact:
 - address: University of Manchester, Oxford Road
   city: Manchester
   country: GB
+  email: spinnakerusers@googlegroups.com
   name: SpiNNaker Software Team
   post-code: M13 9PL
-date-released:
-email: spinnakerusers@googlegroups.com
-identifier:
-message: If you use this software, please cite it as below.
+license: Apache-2.0
 repository: https://github.com/SpiNNakerManchester/spalloc
-title: The client side of the SpiNNaker machine allocation software
-url: http://spinnakermanchester.github.io/
-version:
diff --git a/LICENSE b/LICENSE
@@ -1,7 +1,7 @@
 
                                  Apache License
                            Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+                        https://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
@@ -193,7 +193,7 @@
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
-       http://www.apache.org/licenses/LICENSE-2.0
+       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,

diff --git a/LICENSE.md → LICENSE_POLICY.md b/LICENSE.md → LICENSE_POLICY.md
@@ -1,23 +1,23 @@
 # License Agreement
 
-Up to date information for the whole [SpiNNakerManchester Projects](https://github.com/SpiNNakerManchester) can be found [here](http://spinnakermanchester.github.io/common_pages/4.0.0/LicenseAgreement.html)
+Up to date information for the whole [SpiNNakerManchester Projects](https://github.com/SpiNNakerManchester) can be found [here](http://spinnakermanchester.github.io/latest/LicenseAgreement.html)
 
-As shown there the software is currently being released under the GPL version 3 license listed [here](http://www.gnu.org/copyleft/gpl.html)
+As shown there the software is currently being released under the Apache License 2.0 listed [here](https://www.apache.org/licenses/LICENSE-2.0)
 
 
 # Paper Authorship
 
-See: [here](http://spinnakermanchester.github.io/common_pages/4.0.0/LicenseAgreement.html#paper-authorship)
+See: [here](http://spinnakermanchester.github.io/latest/LicenseAgreement.html#paper-authorship)
 
 # Modifications
 
-See: [here](http://spinnakermanchester.github.io/common_pages/4.0.0/LicenseAgreement.html#modifications)
+See: [here](http://spinnakermanchester.github.io/latest/LicenseAgreement.html#modifications)
 
 # Contributors
 
 For up to date information on Contributors see the graphs/contributors pages on each project.
 
 For example [https://github.com/SpiNNakerManchester/spalloc/graphs/contributors](https://github.com/SpiNNakerManchester/spalloc/graphs/contributors)
 
-[Combined list](http://spinnakermanchester.github.io/common_pages/4.0.0/LicenseAgreement.html#contributors)
+[Combined list](http://spinnakermanchester.github.io/latest/LicenseAgreement.html#contributors)
 
diff --git a/docs/Makefile b/docs/Makefile
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/docs/make.bat b/docs/make.bat
@@ -8,7 +8,7 @@ REM Command file for Sphinx documentation
 : you may not use this file except in compliance with the License.
 : You may obtain a copy of the License at
 :
-:     http://www.apache.org/licenses/LICENSE-2.0
+:     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,

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -6,7 +6,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/pytest.ini b/pytest.ini
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/requirements-test.txt b/requirements-test.txt
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/requirements.txt b/requirements.txt
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/__init__.py b/spalloc/__init__.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/_keepalive_process.py b/spalloc/_keepalive_process.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/_utils.py b/spalloc/_utils.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/_version.py b/spalloc/_version.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/config.py b/spalloc/config.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/job.py b/spalloc/job.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/protocol_client.py b/spalloc/protocol_client.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/scripts/__init__.py b/spalloc/scripts/__init__.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/scripts/alloc.py b/spalloc/scripts/alloc.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/scripts/job.py b/spalloc/scripts/job.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,

diff --git a/spalloc/scripts/machine.py b/spalloc/scripts/machine.py
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,