Merge pull request #51 from dengemann/api-enh

[WIP] add frequency API and compute coffeine API

.github/workflows/build_doc.yml

@@ -0,0 +1,46 @@
+name: Build doc
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - 'master'  
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    # Standard drop-in approach that should work for most people.
+
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.9
+
+    - name: Get Python running
+      run: |
+        python -m pip install --user --upgrade --progress-bar off pip
+        python -m pip install --user --upgrade --progress-bar off -r requirements.txt
+        python -m pip install --user --upgrade --progress-bar off -r doc/requirements.txt
+        python -m pip install --user --upgrade --progress-bar off ipython "https://api.github.com/repos/sphinx-gallery/sphinx-gallery/zipball/master" memory_profiler
+        sudo apt install pandoc
+        python -m pip install --user -e .
+    # Look at what we have and fail early if there is some library conflict
+    - name: Check installation
+      run: |
+        which python
+        python -c "import coffeine"
+        python -c "import pandoc"
+    # Build docs
+    - name: Generate HTML docs
+      uses: rickstaa/sphinx-action@master
+      with:
+        docs-folder: "doc/"
+    - uses: actions/upload-artifact@v2
+      with:
+        name: Documentation
+        path: doc/_build/html/

.github/workflows/unit_tests.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7]
+        python-version: [3.9]
 
     steps:
     - uses: actions/checkout@v2

.gitignore

@@ -4,3 +4,4 @@ junit-results.xml
 *.swp
 *.egg-info
 __pycache__
+doc/generated/*rst

MANIFEST.in

@@ -2,3 +2,17 @@ include LICENSE
 recursive-include coffeine *.py
 recursive-include notebooks *.ipynb
 exclude requirements.txt
+doc/generated/coffeine.spatial_filters.ProjRandomSpace.rst
+doc/generated/coffeine.spatial_filters.ProjSPoCSpace.rst
+doc/index.ipynb
+doc/make.bat
+doc/requirements.txt
+doc/tutorials.ipynb
+doc/tutorials/filterbank_classification_bci.ipynb
+doc/tutorials/filterbank_kernel_classification_bci.ipynb
+recursive-include doc *.bat
+recursive-include doc *.ipynb
+recursive-include doc *.py
+recursive-include doc *.rst
+recursive-include doc *.txt
+recursive-include doc Makefile

coffeine/__init__.py

@@ -26,6 +26,6 @@
 
 from .pipelines import make_filter_bank_transformer, make_filter_bank_regressor, make_filter_bank_classifier   # noqa
 
-from .power_features import compute_features  # noqa
+from .power_features import compute_features, get_frequency_bands, compute_coffeine, make_coffeine_data_frame  # noqa
 
 from .spatial_filters import ProjIdentitySpace, ProjCommonSpace, ProjLWSpace, ProjRandomSpace, ProjSPoCSpace  # noqa