| Name | borsar JSON |
| Version |
0.1
JSON |
| download |
| home_page | |
| Summary | tools for electrophysiological analysis, especially cluster-based tests. |
| upload_time | 2023-10-30 16:35:38 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | BSD-3-Clause |
| keywords |
neuroscience
neuroimaging
meg
eeg
brain
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
|
| coveralls test coverage |
No coveralls.
|
[](https://dl.circleci.com/status-badge/redirect/gh/mmagnuski/borsar/tree/master)
[](https://codecov.io/gh/mmagnuski/borsar)
Various tools, objects and functions for EEG/MEG data analysis and visualisation. Some functionality that is available here may
be later moved to [mne-python](https://martinos.org/mne/dev/index.html).
`borsar` includes:
* `PSD` object for manipulation of power spectral results
* `Clusters` object for storage, manipulation and plotting of clutser-based results, both in channel and sourcee space
* efficient regression for multichannel data (`compute_regression_t`)
* `cluster_based_regression` to perform regression tests in cluster-based permutation framework
* numpy and numba implementations of cluster-based permutation tests in 3d space (for example in `channels x frequency x time` space) with optional filtering by minimum number of adjacent channels (`min_adj_ch`, equivalent of `minnbchan` in fieldtrip).
* `Topo` object for topomap plots that retains the topomap state, allows to mark channels, efficiently update data, change contour line width and style for one or multiple topomaps.
## Installation
`borsar` is not yet released on `PyPI` so to install you have to download it from GitHub using pip in the following way:
```
pip install git+https://github.com/mmagnuski/borsar
```
or, if you plan to frequently update the dev version and contribute to `borsar`, install by cloning the repo with
git and installing in dev mode:
```
cd where_you_want_to_download_borsar
git clone https://github.com/mmagnuski/borsar
cd borsar
python setup.py develop
```
both methods require you to have [git](https://git-scm.com/) installed.
## Documentation
Go to the [online documentation](https://mmagnuski.github.io/borsar.github.io/index.html) for more information about usage examples or full API docs.
:construction: be warned that documentation is under contstruction :construction:
Raw data
{
"_id": null,
"home_page": "",
"name": "borsar",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Miko\u0142aj Magnuski <mmagnuski@swps.edu.pl>",
"keywords": "neuroscience,neuroimaging,MEG,EEG,brain",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/66/49/5af47969ec7d17e56854ff9d7a6f3f91df25a43308ff656f79ac80c97ca3/borsar-0.1.tar.gz",
"platform": null,
"description": "[](https://dl.circleci.com/status-badge/redirect/gh/mmagnuski/borsar/tree/master)\r\n[](https://codecov.io/gh/mmagnuski/borsar)\r\n\r\nVarious tools, objects and functions for EEG/MEG data analysis and visualisation. Some functionality that is available here may\r\nbe later moved to [mne-python](https://martinos.org/mne/dev/index.html).\r\n\r\n`borsar` includes:\r\n* `PSD` object for manipulation of power spectral results\r\n* `Clusters` object for storage, manipulation and plotting of clutser-based results, both in channel and sourcee space\r\n* efficient regression for multichannel data (`compute_regression_t`)\r\n* `cluster_based_regression` to perform regression tests in cluster-based permutation framework\r\n* numpy and numba implementations of cluster-based permutation tests in 3d space (for example in `channels x frequency x time` space) with optional filtering by minimum number of adjacent channels (`min_adj_ch`, equivalent of `minnbchan` in fieldtrip).\r\n* `Topo` object for topomap plots that retains the topomap state, allows to mark channels, efficiently update data, change contour line width and style for one or multiple topomaps.\r\n\r\n\r\n## Installation\r\n`borsar` is not yet released on `PyPI` so to install you have to download it from GitHub using pip in the following way:\r\n```\r\npip install git+https://github.com/mmagnuski/borsar\r\n```\r\nor, if you plan to frequently update the dev version and contribute to `borsar`, install by cloning the repo with\r\ngit and installing in dev mode:\r\n```\r\ncd where_you_want_to_download_borsar\r\ngit clone https://github.com/mmagnuski/borsar\r\ncd borsar\r\npython setup.py develop\r\n```\r\nboth methods require you to have [git](https://git-scm.com/) installed.\r\n\r\n## Documentation\r\nGo to the [online documentation](https://mmagnuski.github.io/borsar.github.io/index.html) for more information about usage examples or full API docs.\r\n:construction: be warned that documentation is under contstruction :construction:\r\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "tools for electrophysiological analysis, especially cluster-based tests.",
"version": "0.1",
"project_urls": {
"Homepage": "https://github.com/mmagnuski/borsar"
},
"split_keywords": [
"neuroscience",
"neuroimaging",
"meg",
"eeg",
"brain"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1152d61928f1ffa71d2b8dada5a63457e757029e0e2f65fc98f1859d4393a18a",
"md5": "5dce4ffda93583f19488364af87f3006",
"sha256": "2be95811b00c988cfdf5348bbb5defd34ed20161293af3bccc172650a0992bcf"
},
"downloads": -1,
"filename": "borsar-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5dce4ffda93583f19488364af87f3006",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 624009,
"upload_time": "2023-10-30T16:35:36",
"upload_time_iso_8601": "2023-10-30T16:35:36.516232Z",
"url": "https://files.pythonhosted.org/packages/11/52/d61928f1ffa71d2b8dada5a63457e757029e0e2f65fc98f1859d4393a18a/borsar-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66495af47969ec7d17e56854ff9d7a6f3f91df25a43308ff656f79ac80c97ca3",
"md5": "65e8b2e6377fab12c37a1529e119c840",
"sha256": "b18b470559e46b29703227cd9f1313d2d3a9ffaca5fa264a7be6f02a89614365"
},
"downloads": -1,
"filename": "borsar-0.1.tar.gz",
"has_sig": false,
"md5_digest": "65e8b2e6377fab12c37a1529e119c840",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 614443,
"upload_time": "2023-10-30T16:35:38",
"upload_time_iso_8601": "2023-10-30T16:35:38.793369Z",
"url": "https://files.pythonhosted.org/packages/66/49/5af47969ec7d17e56854ff9d7a6f3f91df25a43308ff656f79ac80c97ca3/borsar-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-30 16:35:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mmagnuski",
"github_project": "borsar",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "borsar"
}
