Major refactor! Remove additional variation of the "ephys" modules! Support using SpikeInterface for spike sorting

.github/workflows/test.yaml

@@ -1,7 +1,11 @@
 name: Test
 on:
   push:
+    branches:
+      - main
   pull_request:
+    branches:
+      - main
   workflow_dispatch:
 jobs:
   devcontainer-build:
@@ -31,4 +35,3 @@ jobs:
         run: |
           python_version=${{matrix.py_ver}}
           black element_array_ephys --check --verbose --target-version py${python_version//.}
-

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ exclude: (^.github/|^docs/|^images/)
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -16,7 +16,7 @@ repos:
 
   # black
   - repo: https://github.com/psf/black
-    rev: 22.12.0
+    rev: 24.2.0
     hooks:
       - id: black
       - id: black-jupyter
@@ -25,15 +25,15 @@ repos:
 
   # isort
   - repo: https://github.com/pycqa/isort
-    rev: 5.11.2
+    rev: 5.13.2
     hooks:
       - id: isort
         args: ["--profile", "black"]
         description: Sorts imports in an alphabetical order
 
   # flake8
   - repo: https://github.com/pycqa/flake8
-    rev: 4.0.1
+    rev: 7.0.0
     hooks:
       - id: flake8
         args: # arguments to configure flake8

CHANGELOG.md

@@ -3,6 +3,21 @@
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
  [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
+
+## [1.0.0] - 2024-09-10
+
++ Update - No longer support multiple variation of ephys module, keep only `ephys_no_curation` module, renamed to `ephys`
++ Update - Remove other ephys modules (e.g. `ephys_acute`, `ephys_chronic`) (moved to different branches)
++ Update - Add support for `SpikeInterface`
++ Update - Remove support for `ecephys_spike_sorting` (moved to a different branch)
++ Update - Simplify the "activate" mechanism
+
+## [0.4.0] - 2024-08-16
+
++ Add - support for SpikeInterface version >= 0.101.0 (updated API)
++ Add - feature for memoization of spike sorting results (prevent duplicated runs)
+
+
 ## [0.3.5] - 2024-08-16
 
 + Fix - Improve `spikeglx` loader in extracting neuropixels probe type from the meta file

element_array_ephys/__init__.py

@@ -1 +1,3 @@
-from . import ephys_acute as ephys
+from . import ephys
+
+ephys_no_curation = ephys  # alias for backward compatibility