| Name | aeon-neuro JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | A package for ECG and EEG time series analysis built on the aeon toolkit. |
| upload_time | 2024-07-15 19:45:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.8 |
| license | BSD 3-Clause License Copyright (c) The aeon developers. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
data-science
machine-learning
time-series
time-series-analysis
neuroscience
ecg
eeg
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
<p align="center">
<a href="https://aeon-toolkit.org"><img src="https://raw.githubusercontent.com/aeon-toolkit/aeon/main/docs/images/logo/aeon-logo-blue-compact.png" width="50%" alt="aeon logo" /></a>
</p>
# ⌛ 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](https://github.com/the-turing-way) and this package is based on [this template](https://github.com/the-turing-way/reproducible-project-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** | [](https://github.com/aeon-toolkit/aeon-neuro/actions/workflows/release.yml) [](https://github.com/aeon-toolkit/aeon-neuro/actions/workflows/pr_pytest.yml) [](https://github.com/aeon-toolkit/aeon-neuro/actions/workflows/periodic_tests.yml) [](https://aeon-neuro.readthedocs.io/en/stable/?badge=stable) [](https://aeon-neuro.readthedocs.io/en/latest/?badge=latest) [](https://codecov.io/gh/aeon-toolkit/aeon-neuro) |
| **Code** | [](https://pypi.org/project/aeon-neuro/) [](https://www.python.org/) [](https://github.com/psf/black) [](https://github.com/aeon-toolkit/aeon/blob/main/LICENSE) |
| **Community** | [](https://join.slack.com/t/aeon-neuro/shared_invite/zt-2k4qs8mjb-ZZs~6P0MdF8kGf9cUQzKSg) [](https://join.slack.com/t/aeon-toolkit/shared_invite/zt-22vwvut29-HDpCu~7VBUozyfL_8j3dLA) [](https://www.linkedin.com/company/aeon-toolkit/) [](https://twitter.com/aeon_toolkit) |
## ⚙️ Installation
`aeon-neuro` requires a Python version of 3.9 or greater. Our full installation guide is available in our [documentation](https://aeon-neuro.readthedocs.io/en/latest/installation.html).
The easiest way to install `aeon` is via pip:
```bash
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:
```bash
pip install aeon-neuro[all_extras]
```
Instructions for installation from the [GitHub source](https://github.com/aeon-toolkit/aeon-neuro) can be found [here](https://aeon-neuro.readthedocs.io/en/latest/installation.html#install-the-latest-development-version-using-pip).
## 💬 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] |
[GitHub Issue Tracker]: https://github.com/aeon-toolkit/aeon-neuro/issues
[GitHub Discussions]: https://github.com/aeon-toolkit/aeon-neuro/discussions
[Slack]: https://join.slack.com/t/aeon-neuro/shared_invite/zt-2k4qs8mjb-ZZs~6P0MdF8kGf9cUQzKSg
## 💡 Acknowledgements
This work is supported by the UK Engineering and Physical Sciences Research Council
(EPSRC) EP/W030756/2
Raw data
{
"_id": null,
"home_page": null,
"name": "aeon-neuro",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": "aeon developers <contact@aeon-toolkit.org>",
"keywords": "data-science, machine-learning, time-series, time-series-analysis, neuroscience, ECG, EEG",
"author": null,
"author_email": "aeon developers <contact@aeon-toolkit.org>",
"download_url": "https://files.pythonhosted.org/packages/34/9f/c965d78a2954f07c0a03cac27140243ac455a92a8338d44f4c49181f827e/aeon_neuro-0.0.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://aeon-toolkit.org\"><img src=\"https://raw.githubusercontent.com/aeon-toolkit/aeon/main/docs/images/logo/aeon-logo-blue-compact.png\" width=\"50%\" alt=\"aeon logo\" /></a>\n</p>\n\n# \u231b Welcome to aeon-neuro\n\n`aeon-neuro` is package that unifies techniques for the classification of EEG time\nseries. Our goal is to present a simple and unified interface to a variety of EEG\nclassification problems that combine techniques from a range of domains that learn\nfrom EEG signals.\n\nWe aim to develop this package following the principles of open science, and\nreproducible research, as described in the [Turing Way](https://github.com/the-turing-way) and this package is based on [this template](https://github.com/the-turing-way/reproducible-project-template).\n\n`aeon-neuro` is a companion package to the `aeon` toolkit. The main project webpage\nand documentation is available at https://aeon-toolkit.org and the source code at\nhttps://github.com/aeon-toolkit/aeon.\n\nThe initial `aeon-neuro` release is `v0.0.1`.\n\nOur webpage and documentation is available at https://aeon-neuro.readthedocs.io.\n\n| Overview | |\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **CI/CD** | [](https://github.com/aeon-toolkit/aeon-neuro/actions/workflows/release.yml) [](https://github.com/aeon-toolkit/aeon-neuro/actions/workflows/pr_pytest.yml) [](https://github.com/aeon-toolkit/aeon-neuro/actions/workflows/periodic_tests.yml) [](https://aeon-neuro.readthedocs.io/en/stable/?badge=stable) [](https://aeon-neuro.readthedocs.io/en/latest/?badge=latest) [](https://codecov.io/gh/aeon-toolkit/aeon-neuro) |\n| **Code** | [](https://pypi.org/project/aeon-neuro/) [](https://www.python.org/) [](https://github.com/psf/black) [](https://github.com/aeon-toolkit/aeon/blob/main/LICENSE) |\n| **Community** | [](https://join.slack.com/t/aeon-neuro/shared_invite/zt-2k4qs8mjb-ZZs~6P0MdF8kGf9cUQzKSg) [](https://join.slack.com/t/aeon-toolkit/shared_invite/zt-22vwvut29-HDpCu~7VBUozyfL_8j3dLA) [](https://www.linkedin.com/company/aeon-toolkit/) [](https://twitter.com/aeon_toolkit) |\n\n## \u2699\ufe0f Installation\n\n`aeon-neuro` requires a Python version of 3.9 or greater. Our full installation guide is available in our [documentation](https://aeon-neuro.readthedocs.io/en/latest/installation.html).\n\nThe easiest way to install `aeon` is via pip:\n\n```bash\npip install aeon-neuro\n```\n\nSome estimators require additional packages to be installed. If you want to install\nthe full package with all optional dependencies, you can use:\n\n```bash\npip install aeon-neuro[all_extras]\n```\n\nInstructions for installation from the [GitHub source](https://github.com/aeon-toolkit/aeon-neuro) can be found [here](https://aeon-neuro.readthedocs.io/en/latest/installation.html#install-the-latest-development-version-using-pip).\n\n\n## \ud83d\udcac Where to ask questions\n\n| Type | Platforms |\n|-------------------------------------|----------------------------------|\n| \ud83d\udc1b **Bug Reports** | [GitHub Issue Tracker] |\n| \u2728 **Feature Requests & Ideas** | [GitHub Issue Tracker] & [Slack] |\n| \ud83d\udcbb **Usage Questions** | [GitHub Discussions] & [Slack] |\n| \ud83d\udcac **General Discussion** | [GitHub Discussions] & [Slack] |\n| \ud83c\udfed **Contribution & Development** | [Slack] |\n\n[GitHub Issue Tracker]: https://github.com/aeon-toolkit/aeon-neuro/issues\n[GitHub Discussions]: https://github.com/aeon-toolkit/aeon-neuro/discussions\n[Slack]: https://join.slack.com/t/aeon-neuro/shared_invite/zt-2k4qs8mjb-ZZs~6P0MdF8kGf9cUQzKSg\n\n\n## \ud83d\udca1 Acknowledgements\nThis work is supported by the UK Engineering and Physical Sciences Research Council\n(EPSRC) EP/W030756/2\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) The aeon developers. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "A package for ECG and EEG time series analysis built on the aeon toolkit.",
"version": "0.0.1",
"project_urls": {
"Download": "https://pypi.org/project/aeon-neuro/#files",
"Homepage": "https://www.aeon-toolkit.org",
"Repository": "https://github.com/aeon-toolkit/aeon-neuro"
},
"split_keywords": [
"data-science",
" machine-learning",
" time-series",
" time-series-analysis",
" neuroscience",
" ecg",
" eeg"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc93ac7b8ec84165ad0441f571a2f4c9c8e6397833863b03e1609b610f262427",
"md5": "0b7667e6b294b4306cd3a2fbb4a048d3",
"sha256": "a222ec7b8f0184c1d9b6027c08e18e79b45284d6bedd79cebfde8e456d044340"
},
"downloads": -1,
"filename": "aeon_neuro-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b7667e6b294b4306cd3a2fbb4a048d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 76012074,
"upload_time": "2024-07-15T19:45:09",
"upload_time_iso_8601": "2024-07-15T19:45:09.745603Z",
"url": "https://files.pythonhosted.org/packages/bc/93/ac7b8ec84165ad0441f571a2f4c9c8e6397833863b03e1609b610f262427/aeon_neuro-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "349fc965d78a2954f07c0a03cac27140243ac455a92a8338d44f4c49181f827e",
"md5": "60f8a349b6479093119654c50f492b8e",
"sha256": "8510885223f466729339208c407c6bbf40f4a4c406301a45bbd8b129423e59c3"
},
"downloads": -1,
"filename": "aeon_neuro-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "60f8a349b6479093119654c50f492b8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 75978620,
"upload_time": "2024-07-15T19:45:15",
"upload_time_iso_8601": "2024-07-15T19:45:15.328977Z",
"url": "https://files.pythonhosted.org/packages/34/9f/c965d78a2954f07c0a03cac27140243ac455a92a8338d44f4c49181f827e/aeon_neuro-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-15 19:45:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aeon-toolkit",
"github_project": "aeon-neuro",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "aeon-neuro"
}
