aeon-toolkit / aeon-neuro

A package for EEG time series classification built on the aeon toolkit.
https://aeon-neuro.readthedocs.io
BSD 3-Clause "New" or "Revised" License
8 stars 6 forks source link

aeon logo

⌛ Welcome to aeon-neuro

aeon-neuro is package that unifies techniques for the classification of EEG time series. Our goal is to present a simple and unified interface to a variety of EEG classification problems that combine techniques from a range of domains that learn from EEG signals.

We aim to develop this package following the principles of open science, and reproducible research, as described in the Turing Way and this package is based on this template.

aeon-neuro is a companion package to the aeon toolkit. The main project webpage and documentation is available at https://aeon-toolkit.org and the source code at https://github.com/aeon-toolkit/aeon.

The initial aeon-neuro release is v0.0.1.

Our webpage and documentation is available at https://aeon-neuro.readthedocs.io.

Overview
CI/CD github-actions-release github-actions-main github-actions-nightly docs-main docs-main !codecov
Code !pypi !python-versions !black license
Community !slack !slack-aeon !linkedin !twitter

⚙️ Installation

aeon-neuro requires a Python version of 3.9 or greater. Our full installation guide is available in our documentation.

The easiest way to install aeon is via pip:

pip install aeon-neuro

Some estimators require additional packages to be installed. If you want to install the full package with all optional dependencies, you can use:

pip install aeon-neuro[all_extras]

Instructions for installation from the GitHub source can be found here.

💬 Where to ask questions

Type Platforms
🐛 Bug Reports GitHub Issue Tracker
Feature Requests & Ideas GitHub Issue Tracker & Slack
💻 Usage Questions GitHub Discussions & Slack
💬 General Discussion GitHub Discussions & Slack
🏭 Contribution & Development Slack

💡 Acknowledgements

This work is supported by the UK Engineering and Physical Sciences Research Council (EPSRC) EP/W030756/2