Add project citation metadata and centralize copyright notices

.github/workflows/tests.yml

@@ -1,5 +1,4 @@
 # ...
-# Copyright 2021 Brooks M. Musangu and Jan Drugowitsch.
 # license Modified BSD, see LICENSE.txt for details.
 # ...
 name: CI Tests and Docs
@@ -12,8 +11,12 @@ on:
 
 jobs:
   test:
-    name: Run Pytest Suite
+    name: Test Python ${{ matrix.python-version }}
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - name: Checkout repository
@@ -22,7 +25,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.x'
+          python-version: ${{ matrix.python-version }}
 
       - name: Install package and test dependencies
         run: |
@@ -44,7 +47,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.x'
+          python-version: "3.13"
 
       - name: Install Pandoc
         run: |

CITATION.cff

@@ -0,0 +1,27 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it using the metadata below."
+type: software
+title: "BlockInvGPFA"
+abstract: >-
+  A scikit-learn-compatible implementation of Gaussian-process factor
+  analysis using block matrix inversion for efficient inference with
+  variable-length time series.
+authors:
+  - family-names: "Musangu"
+    given-names: "Brooks M."
+    email: "brooks_musangu@hms.harvard.edu"
+    affiliation: "Department of Neurobiology, Harvard Medical School"
+    orcid: "https://orcid.org/0000-0002-7137-3707"
+  - family-names: "Drugowitsch"
+    given-names: "Jan"
+    email: "jan_drugowitsch@hms.harvard.edu"
+    affiliation: "Department of Neurobiology, Harvard Medical School"
+    orcid: "https://orcid.org/0000-0002-7846-0408"
+version: "0.1.0"
+license: "BSD-3-Clause"
+repository-code: "https://github.com/CausalityInMotion/BlockInverseGPFA"
+url: "https://blockinversegpfa.readthedocs.io/en/latest/"
+keywords:
+  - "Gaussian Processes"
+  - "block matrices"
+  - "latent variable models"

LICENSE.txt

@@ -1,5 +1,5 @@
 Code based on Elephant - Electrophysiology Analysis Toolkit: Copyright (c) 2014-2019, Elephant authors and contributors
-Modifications and additions: Copyright (c) 2021 Brooks M. Musangu and Jan Drugowitsch
+Modifications and additions: Copyright (c) 2021-2026 Brooks M. Musangu and Jan Drugowitsch
 All rights reserved.
 
 

README.md

@@ -82,10 +82,6 @@ Tests are automatically run via [GitHub Actions](https://github.com/CausalityInM
 Modified BSD License based on Elephant, see [LICENSE.txt](LICENSE.txt) for details.
 
 
-## Copyright
-
-:copyright: 2021-2025 Brooks M. Musangu and Jan Drugowitsch
-
 ## Acknowledgments
 
-See [acknowledgments](docs/acknowledgments.rst).
+See [acknowledgments](docs/acknowledgments.rst).

blockinvgpfa/__init__.py

@@ -1,6 +1,5 @@
 """
-:copyright: Copyright 2021 Brooks M. Musangu and Jan Drugowitsch.
-:license: Modified BSD, see LICENSE.txt for details.
+:license: Modified BSD, see LICENSE.txt for details.
 """
 from .blockinvgpfa import BlockInvGPFA
 from .preprocessing import EventTimesToCounts

blockinvgpfa/blockinvgpfa.py

@@ -1,7 +1,5 @@
 # ...
-# Copyright 2021 Brooks M. Musangu and Jan Drugowitsch.
-# Copyright 2014-2020 by the Elephant team.
-# Modified BSD, see LICENSE.txt for details.
+# Modified BSD, see LICENSE.txt for details.
 # ...
 
 from __future__ import division, print_function, unicode_literals

blockinvgpfa/preprocessing.py

@@ -1,5 +1,4 @@
 # ...
-# Copyright 2021 Brooks M. Musangu and Jan Drugowitsch.
 # license Modified BSD, see LICENSE.txt for details.
 # ...
 
@@ -53,7 +52,7 @@ class EventTimesToCounts(sklearn.base.TransformerMixin):
     Examples
     --------
     >>> import numpy as np
-    >>> from gpfa import EventTimesToCounts
+    >>> from blockinvgpfa import EventTimesToCounts
     >>> bin_size = 0.1  # [s]
     >>> t_stop = 0.8  # [s]
     >>> X = [

docs/conf.py

@@ -5,7 +5,6 @@
 
 import sys
 import os
-from datetime import date
 
 # include root path to allow autodoc to find blockgpfa module
 sys.path.insert(0, os.path.abspath('../'))
@@ -24,9 +23,8 @@
 
 project = 'BlockInvGPFA Documentation'
 authors = 'Brooks M. Musangu and Jan Drugowitsch'
-copyright = "2021-{this_year}, {authors}".format(
-    this_year=date.today().year, authors=authors)
-release = '0.1.0.'
+copyright = f"2021, {authors}"
+release = '0.1.0'
 version = '0.1.0'
 
 # -- General configuration ---------------------------------------------------

pyproject.toml

@@ -7,12 +7,12 @@ name = "blockinversegpfa"
 version = "0.1.0"
 description = "A scikit-learn-compatible GPFA implementation using block matrix inversion."
 authors = [
-    {name = "Brooks M. MUSANGU", email = "brooks_musangu@hms.harvard.edu"},
-    {name = "Jan DRUGOWITSCH", email = "jan_drugowitsch@hms.harvard.edu"}
+    {name = "Brooks M. Musangu", email = "brooks_musangu@hms.harvard.edu"},
+    {name = "Jan Drugowitsch", email = "jan_drugowitsch@hms.harvard.edu"}
 ]
 license = {file = "LICENSE.txt"}
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10,<3.14"
 dependencies = [
     "numpy==2.2.1",
     "scikit-learn==1.6.0",

test/test_blockinvgpfa.py

@@ -1,5 +1,4 @@
 # ...
-# Copyright 2021 Brooks M. Musangu and Jan Drugowitsch.
 # license Modified BSD, see LICENSE.txt for details.
 # ...
 """

test/test_preprocessing.py

@@ -1,5 +1,4 @@
 # ...
-# Copyright 2021 Brooks M. Musangu and Jan Drugowitsch.
 # license Modified BSD, see LICENSE.txt for details.
 # ...
 """