Merge pull request #645 from neuropsychology/dev

0.2.1

.gitattributes

@@ -1 +1,2 @@
-scripts/* linguist-vendored
+scripts/* linguist-vendored
+*.ipynb linguist-language=Python

.github/CONTRIBUTING.rst

@@ -21,6 +21,13 @@ Contributing is the best way to learn programming, to meet new people, to grow y
 
 For instance, authors of significant contributions (features, tough bug fixes etc.) will be listed as official `Contributors <https://neuropsychology.github.io/NeuroKit/authors.html>`_ section of our website. Additionally, frequent contributors that also get involved in general maintaining (e.g,participating in issues, fixing stuff, reviewing PRs, writing docs etc.) might be included in as package maintainers, in which case they'll be expected to be more generally involved in the general development direction. Finally, we expect this project (the development of the package *per se* and all of the discussions/experiments that are around it) to result in several **publications** (could be about some features of the package, but also some tutorial papers, validation studies or whatnot. Obviously, people that contributed and allowed for a paper to be written will be included as authors.
 
+.. tip::
+
+    On top of this, you can add that you are a contributor of NeuroKit to your CV. Since many labs
+    and companies use it, they might be particularly interested in recruiting someone that
+    has a good understanding of NeuroKit, and demonstrated skills in Python and software
+    development.
+
 Long story short, we want this project to be helpful to you, whether you're a user, a contributor, or anything else in between :) And as always, do not hesitate to ask us if you have any questions.
 
 

.github/stale.yml

@@ -1,17 +1,17 @@
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 180
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 180
-# Issues with these labels will never be considered stale
-exemptLabels:
-  - feature idea 🔥
-  - bug 🐛
-# Label to use when marking an issue as stale
-staleLabel: inactive 👻
-# Comment to post when marking an issue as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as inactive because it has not had
-  recent activity. It will eventually be closed if no further activity occurs.
-# Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: >
-  This issue has been inactive for a long time. We're closing it (but feel free to reopen it if need be).
+# # Number of days of inactivity before an issue becomes stale
+# daysUntilStale: 180
+# # Number of days of inactivity before a stale issue is closed
+# daysUntilClose: 180
+# # Issues with these labels will never be considered stale
+# exemptLabels:
+#   - feature idea 🔥
+#   - bug 🐛
+# # Label to use when marking an issue as stale
+# staleLabel: inactive 👻
+# # Comment to post when marking an issue as stale. Set to `false` to disable
+# markComment: >
+#   This issue has been automatically marked as inactive because it has not had
+#   recent activity. It will eventually be closed if no further activity occurs.
+# # Comment to post when closing a stale issue. Set to `false` to disable
+# closeComment: >
+#   This issue has been inactive for a long time. We're closing it (but feel free to reopen it if need be).

.github/workflows/checks.yml

@@ -4,28 +4,28 @@ name: 🌼 Release checks
 on: pull_request
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@master
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
 
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: '3.8'
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v4
+              with:
+                  python-version: "3.8"
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        cd $GITHUB_WORKSPACE && pip install .[test]
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  cd $GITHUB_WORKSPACE && pip install .[test]
 
-    - name: Run README_examples.py
-      run: |
-        cd $GITHUB_WORKSPACE/docs/readme
-        python README_examples.py
+            - name: Run README_examples.py
+              run: |
+                  cd $GITHUB_WORKSPACE/docs/readme
+                  python README_examples.py
 
-    - name: Build package and test with twine
-      run: |
-        python -m pip install --upgrade setuptools pip wheel twine
-        python setup.py sdist bdist_wheel
-        python -m twine check dist/*
+            - name: Build package and test with twine
+              run: |
+                  python -m pip install --upgrade setuptools pip wheel twine
+                  python setup.py sdist bdist_wheel
+                  python -m twine check dist/*

.github/workflows/codeql-analysis.yml

@@ -12,59 +12,59 @@
 name: "Security"
 
 on:
-  push:
-    branches: [ dev ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ dev ]
-  schedule:
-    - cron: '24 2 * * 3'
+    push:
+        branches: [dev]
+    pull_request:
+        # The branches below must be a subset of the branches above
+        branches: [dev]
+    schedule:
+        - cron: "24 2 * * 3"
 
 jobs:
-  analyze:
-    name: CodeQL
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
+    analyze:
+        name: CodeQL
+        runs-on: ubuntu-latest
+        permissions:
+            actions: read
+            contents: read
+            security-events: write
 
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'python' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+        strategy:
+            fail-fast: false
+            matrix:
+                language: ["python"]
+                # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+                # Learn more about CodeQL language support at https://git.io/codeql-language-support
 
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+            # Initializes the CodeQL tools for scanning.
+            - name: Initialize CodeQL
+              uses: github/codeql-action/init@v1
+              with:
+                  languages: ${{ matrix.language }}
+                  # If you wish to specify custom queries, you can do so here or in a config file.
+                  # By default, queries listed here will override any specified in a config file.
+                  # Prefix the list here with "+" to use these queries and those in the config file.
+                  # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+            # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+            # If this step fails, then you should remove it and run the build manually (see below)
+            - name: Autobuild
+              uses: github/codeql-action/autobuild@v1
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+            # ℹ️ Command-line programs to run using the OS shell.
+            # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+            # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+            #    and modify them (or add more) to build your code if your project
+            #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+            #- run: |
+            #   make bootstrap
+            #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+            - name: Perform CodeQL Analysis
+              uses: github/codeql-action/analyze@v1

.github/workflows/docs-build.yml

@@ -1,56 +1,56 @@
 name: "📜 Documentation builder"
 
 on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-
+    push:
+        branches:
+            - master
+    pull_request:
+        branches:
+            - master
 
 jobs:
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 0 # To be able to push refs to destination repo
-    - name: Set up Python 🐍
-      uses: actions/setup-python@v3
-      with:
-        cache: 'pip'
+    docs:
+        runs-on: windows-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0 # To be able to push refs to destination repo
+            - name: Set up Python 🐍
+              uses: actions/setup-python@v4
+              with:
+                  python-version: "3.10"
+                  cache: "pip"
 
-    - name: Install dependencies 🏭
-      run: |
-        python -m pip install --upgrade pip
-        pip install sphinx-book-theme
-        pip install sphinxemoji
-        pip install sphinx-copybutton
-        pip install ipython
-        pip install myst-parser
-        pip install myst-nb
-        pip install numpy
-        pip install pandas
-        pip install scipy
-        pip install scikit-learn
-        pip install matplotlib
-        pip install mne
-        pip install PyWavelets
-        pip install EMD-signal
-        pip install astropy
-        pip install seaborn
-        pip install EMD-signal
-        pip install cvxopt
-        pip install https://github.com/neuropsychology/neurokit/zipball/dev
+            - name: Install dependencies 🏭
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install sphinx-book-theme
+                  pip install sphinxemoji
+                  pip install sphinx-copybutton
+                  pip install ipython
+                  pip install myst-parser
+                  pip install myst-nb
+                  pip install numpy
+                  pip install pandas
+                  pip install scipy
+                  pip install scikit-learn
+                  pip install matplotlib
+                  pip install mne
+                  pip install PyWavelets
+                  pip install EMD-signal
+                  pip install astropy
+                  pip install seaborn
+                  pip install EMD-signal
+                  pip install cvxopt
+                  pip install https://github.com/neuropsychology/neurokit/zipball/dev
 
-    - name: Build documentation 📜
-      run: |
-        cd docs
-        sphinx-build -b html . _build
+            - name: Build documentation 📜
+              run: |
+                  cd docs
+                  sphinx-build -b html . _build
 
-    - name: Deploy 🚀
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./docs/_build
+            - name: Deploy 🚀
+              uses: peaceiris/actions-gh-pages@v3
+              with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  publish_dir: ./docs/_build

.github/workflows/docs-check.yml

@@ -1,42 +1,44 @@
 name: "📜 Documentation check"
 on:
-- pull_request
+    - pull_request
 
 jobs:
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 0 # To be able to push refs to destination repo
-    - name: Set up Python 🐍
-      uses: actions/setup-python@v3
-      with:
-        cache: 'pip'
+    docs:
+        runs-on: windows-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0 # To be able to push refs to destination repo
+            - name: Set up Python 🐍
+              uses: actions/setup-python@v4
+              with:
+                  python-version: "3.10"
+                  cache: "pip"
 
-    - name: Install dependencies 🏭
-      run: |
-        python -m pip install --upgrade pip
-        pip install sphinx-book-theme
-        pip install sphinxemoji
-        pip install sphinx-copybutton
-        pip install ipython
-        pip install myst-parser
-        pip install myst-nb
-        pip install numpy
-        pip install pandas
-        pip install scipy
-        pip install scikit-learn
-        pip install matplotlib
-        pip install mne
-        pip install PyWavelets
-        pip install astropy
-        pip install seaborn
-        pip install EMD-signal
-        pip install cvxopt
-        pip install https://github.com/neuropsychology/neurokit/zipball/dev
+            - name: Install dependencies 🏭
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install sphinx
+                  pip install sphinx-book-theme
+                  pip install sphinxemoji
+                  pip install sphinx-copybutton
+                  pip install ipython
+                  pip install myst-parser
+                  pip install myst-nb
+                  pip install numpy
+                  pip install pandas
+                  pip install scipy
+                  pip install scikit-learn
+                  pip install matplotlib
+                  pip install mne
+                  pip install PyWavelets
+                  pip install astropy
+                  pip install seaborn
+                  pip install EMD-signal
+                  pip install cvxopt
+                  pip install https://github.com/neuropsychology/neurokit/zipball/dev
 
-    - name: Build documentation 📜
-      run: |
-        cd docs
-        sphinx-build -b html . _build
+            - name: Build documentation 📜
+              run: |
+                  cd docs
+                  sphinx-build -b html . _build