Added tests configuration to run in GitHub automatically

Author: laurator

.github/workflows/tests.yml

@@ -0,0 +1,58 @@
+name: Ncpi Tests
+
+on:
+  push:
+    branches: [ main, master, ncpi-tests ]
+  pull_request:
+    branches: [ main, master, ncpi-tests ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Cache downloaded file
+      uses: actions/cache@v4
+      id: file-cache
+      with:
+          path: |
+            tests/data/zenodo_test_files_LFP/zenodo_sim_files
+            tests/data/zenodo_test_files_LFP/zenodo_emp_files
+          key: ${{ runner.os }}-file-${{ hashFiles('requirements.txt') }}-v1
+
+    - name: Create directory for tests data (empty in repo)
+      if: steps.file-cache.outputs.cache-hit != 'true'
+      run: |
+        mkdir -p tests/data/zenodo_test_files_LFP
+
+    - name: Download files (if they are not cached)
+      if: steps.file-cache.outputs.cache-hit != 'true'
+      run: |
+        # Download partial zenodo simulation test data (~196 MB) and extract files
+        wget -O tests/data/zenodo_test_files_LFP/zenodo_sim_test_files_LFP.7z https://zenodo.org/records/17427470/files/zenodo_sim_test_files_LFP.7z
+        7z x tests/data/zenodo_test_files_LFP/zenodo_sim_test_files_LFP.7z -otests/data/zenodo_test_files_LFP/
+        rm tests/data/zenodo_test_files_LFP/zenodo_sim_test_files_LFP.7z  # Free space immediately
+
+        # Download partial zenodo empirical test data (~490 MB) and extract files
+        wget -O tests/data/zenodo_test_files_LFP/zenodo_emp_test_files_LFP.7z https://zenodo.org/records/17427470/files/zenodo_emp_test_files_LFP.7z
+        7z x tests/data/zenodo_test_files_LFP/zenodo_emp_test_files_LFP.7z -otests/data/zenodo_test_files_LFP/
+        rm tests/data/zenodo_test_files_LFP/zenodo_emp_test_files_LFP.7z  # Free space immediately
+        
+        
+    - name: List test data files
+      run: |
+        ls -lhat tests/data/zenodo_test_files_LFP
+        echo "Data size:"
+        du -sh tests/data/zenodo_test_files_LFP  # Check size
+          
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools
+        pip install pytest
+        pip install -r requirements.txt
+        pip install . # overwrites ncpi python package. It installs the current version of this repository
+        
+    - name: Run tests with pytest
+      run: |
+        pytest -v

pytest.ini

@@ -0,0 +1,6 @@
+# pytest.ini or .pytest.ini
+[pytest]
+testpaths = tests
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*

requirements.txt

@@ -0,0 +1,5 @@
+# requirements.txt
+ncpi
+# p7zip-full 
+# wget
+# LFPykernels

tests/test_LFP/test_LFP.py

@@ -41,10 +41,6 @@
 # Paths to zenodo empirical files
 zenodo_dir_emp= os.path.join(test_dir, "..", "data", "zenodo_test_files_LFP", "zenodo_emp_files") # Dir of GitHub testing downloaded files (set in tests.yml)
 
-# ML model used to compute the predictions
-ML_model = 'MLPRegressor'
-
-
 def LFP_mean(method):
     """
     Compute only certain data for testing and calculate the average