# pyNIBS
Preprocessing, postprocessing, and analyses routines for non-invasive brain stimulation experiments.
[![Latest Release](https://gitlab.gwdg.de/tms-localization/pynibs/-/badges/release.svg)](https://gitlab.gwdg.de/tms-localization/pynibs)
[![Documentation](https://readthedocs.org/projects/pynibs/badge/)](https://pynibs.readthedocs.io/)
[![pipeline status](https://gitlab.gwdg.de/tms-localization/pynibs/badges/master/pipeline.svg)](https://gitlab.gwdg.de/tms-localization/pynibs/commits/master)
[![coverage report](https://gitlab.gwdg.de/tms-localization/pynibs/badges/master/coverage.svg)](https://tms-localization.pages.gwdg.de/pynibs)
![](https://gitlab.gwdg.de/uploads/-/system/project/avatar/9753/Fig_4.png?width=128)
`pyNIBS` provides the functions to allow **cortical mappings** with transcranial magnetic stimulation (TMS) via **functional analysis**. `pyNIBS` is developed to work with [SimNIBS](http://www.simnibs.org), i.e. SimNIBS' meshes and FEM results can directly be used.
Currently, [SimNIBS 3.2.6](https://github.com/simnibs/simnibs/releases/tag/v3.2.6) and [SimNIBS 4.0.1](https://github.com/simnibs/simnibs/releases/tag/v4.0.0) is supported.
See the [documentation](https://pynibs.readthedocs.io/) for package details and our [protocol](https://doi.org/10.1038/s41596-022-00776-6) publication for a extensive usage examples. Free view only version of the paper: https://t.co/uv7CmVw6tp.
## Installation
Via PiP:
``` bash
pip install pynibs
```
Or clone the source repository and install via `setup.py`:
``` bash
git clone https://gitlab.gwdg.de/tms-localization/pynibs
cd pynibs
python setup.py develop
```
To import CED Signal EMG data use the `export to .mat` feature of Signal.
To read `.cfs` files exported with CED Signal you might need to [manually](HOW_TO_INSTALL_BIOSIG.txt) compile the libbiosig package.
## Bugs
For sure. Please open an [issue](https://gitlab.gwdg.de/tms-localization/pynibs/-/issues) or feel free to file a PR.
## Citation
Please cite _Numssen, O., Zier, A. L., Thielscher, A., Hartwigsen, G., Knösche, T. R., & Weise, K. (2021). Efficient high-resolution TMS mapping of the human motor cortex by nonlinear regression. NeuroImage, 245, 118654. doi:[10.1016/j.neuroimage.2021.118654](https://doi.org/10.1016/j.neuroimage.2021.118654)_ when using this toolbox in your research.
## References
- Weise*, K., Numssen*, O., Thielscher, A., Hartwigsen, G., & Knösche, T. R. (2020). A novel approach to localize cortical TMS effects. *NeuroImage*, 209, 116486. doi: [10.1016/j.neuroimage.2019.116486](https://doi.org/10.1016/j.neuroimage.2019.116486)
- Numssen, O., Zier, A. L., Thielscher, A., Hartwigsen, G., Knösche, T. R., & Weise, K. (2021). Efficient high-resolution TMS mapping of the human motor cortex by nonlinear regression. *NeuroImage*, 245, 118654. doi:[10.1016/j.neuroimage.2021.118654](https://doi.org/10.1016/j.neuroimage.2021.118654)
- Weise*, K., Numssen*, O., Kalloch, B., Zier, A. L., Thielscher, A., Hartwigsen°, G., Knösche°, T. R. (2023). Precise transcranial magnetic stimulation motor-mapping. *Nature Protocols*. doi:[10.1038/s41596-022-00776-6](https://doi.org/10.1038/s41596-022-00776-6)
- Jing, Y., Numssen, O., Weise, K., Kalloch, B., Buchberger, L., Haueisen, J., Hartwigsen, G., Knösche, T. (2023). Modeling the Effects of Transcranial Magnetic Stimulation on Spatial Attention. *bioRxiv*. doi: [10.1101/2023.01.11.523548](https://doi.org/10.1101/2023.01.11.523548)
Raw data
{
"_id": null,
"home_page": "",
"name": "pynibs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "NIBS,non-invasive brain stimulation,TMS,FEM",
"author": "Konstantin Weise, Ole Numssen, Benjamin Kalloch",
"author_email": "kweise@cbs.mpg.de",
"download_url": "https://files.pythonhosted.org/packages/7e/1b/262c4a2b18c35d589ccad558cc8aebdc335265dc0fcd4ef8ea53d70de9c9/pynibs-0.2023.8.tar.gz",
"platform": null,
"description": "# pyNIBS\nPreprocessing, postprocessing, and analyses routines for non-invasive brain stimulation experiments.\n\n[![Latest Release](https://gitlab.gwdg.de/tms-localization/pynibs/-/badges/release.svg)](https://gitlab.gwdg.de/tms-localization/pynibs)\n[![Documentation](https://readthedocs.org/projects/pynibs/badge/)](https://pynibs.readthedocs.io/)\n[![pipeline status](https://gitlab.gwdg.de/tms-localization/pynibs/badges/master/pipeline.svg)](https://gitlab.gwdg.de/tms-localization/pynibs/commits/master)\n[![coverage report](https://gitlab.gwdg.de/tms-localization/pynibs/badges/master/coverage.svg)](https://tms-localization.pages.gwdg.de/pynibs)\n\n![](https://gitlab.gwdg.de/uploads/-/system/project/avatar/9753/Fig_4.png?width=128)\n\n`pyNIBS` provides the functions to allow **cortical mappings** with transcranial magnetic stimulation (TMS) via **functional analysis**. `pyNIBS` is developed to work with [SimNIBS](http://www.simnibs.org), i.e. SimNIBS' meshes and FEM results can directly be used.\n Currently, [SimNIBS 3.2.6](https://github.com/simnibs/simnibs/releases/tag/v3.2.6) and [SimNIBS 4.0.1](https://github.com/simnibs/simnibs/releases/tag/v4.0.0) is supported.\n\nSee the [documentation](https://pynibs.readthedocs.io/) for package details and our [protocol](https://doi.org/10.1038/s41596-022-00776-6) publication for a extensive usage examples. Free view only version of the paper: https://t.co/uv7CmVw6tp.\n\n## Installation\nVia PiP:\n\n``` bash\npip install pynibs\n```\n\nOr clone the source repository and install via `setup.py`:\n\n``` bash\ngit clone https://gitlab.gwdg.de/tms-localization/pynibs\ncd pynibs\npython setup.py develop\n```\n\nTo import CED Signal EMG data use the `export to .mat` feature of Signal. \nTo read `.cfs` files exported with CED Signal you might need to [manually](HOW_TO_INSTALL_BIOSIG.txt) compile the libbiosig package.\n\n\n## Bugs\nFor sure. Please open an [issue](https://gitlab.gwdg.de/tms-localization/pynibs/-/issues) or feel free to file a PR.\n\n\n## Citation\nPlease cite _Numssen, O., Zier, A. L., Thielscher, A., Hartwigsen, G., Kn\u00f6sche, T. R., & Weise, K. (2021). Efficient high-resolution TMS mapping of the human motor cortex by nonlinear regression. NeuroImage, 245, 118654. doi:[10.1016/j.neuroimage.2021.118654](https://doi.org/10.1016/j.neuroimage.2021.118654)_ when using this toolbox in your research.\n\n\n## References\n - Weise*, K., Numssen*, O., Thielscher, A., Hartwigsen, G., & Kn\u00f6sche, T. R. (2020). A novel approach to localize cortical TMS effects. *NeuroImage*, 209, 116486. doi: [10.1016/j.neuroimage.2019.116486](https://doi.org/10.1016/j.neuroimage.2019.116486)\n - Numssen, O., Zier, A. L., Thielscher, A., Hartwigsen, G., Kn\u00f6sche, T. R., & Weise, K. (2021). Efficient high-resolution TMS mapping of the human motor cortex by nonlinear regression. *NeuroImage*, 245, 118654. doi:[10.1016/j.neuroimage.2021.118654](https://doi.org/10.1016/j.neuroimage.2021.118654)\n - Weise*, K., Numssen*, O., Kalloch, B., Zier, A. L., Thielscher, A., Hartwigsen\u00b0, G., Kn\u00f6sche\u00b0, T. R. (2023). Precise transcranial magnetic stimulation motor-mapping. *Nature Protocols*. doi:[10.1038/s41596-022-00776-6](https://doi.org/10.1038/s41596-022-00776-6) \n - Jing, Y., Numssen, O., Weise, K., Kalloch, B., Buchberger, L., Haueisen, J., Hartwigsen, G., Kn\u00f6sche, T. (2023). Modeling the Effects of Transcranial Magnetic Stimulation on Spatial Attention. *bioRxiv*. doi: [10.1101/2023.01.11.523548](https://doi.org/10.1101/2023.01.11.523548)\n",
"bugtrack_url": null,
"license": "GPL3",
"summary": "A python toolbox to conduct non-invasive brain stimulation experiments (NIBS).",
"version": "0.2023.8",
"project_urls": {
"Docs": "https://pynibs.readthedocs.io/",
"Download": "https://pypi.org/project/pynibs/",
"Home": "https://gitlab.gwdg.de/tms-localization/pynibs",
"Twitter": "https://www.twitter.com/num_ole"
},
"split_keywords": [
"nibs",
"non-invasive brain stimulation",
"tms",
"fem"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff6d2ea16fc6c2245bd5d6deb258f129de3b44dbd3bdf243d1de40ea7c5c1fa4",
"md5": "bec9744cee33e9c0053b7d9a40a58bcd",
"sha256": "8a1425b143a806baf86e0d8118659e52bac547f80c4bd8ddf393cc4e478e5521"
},
"downloads": -1,
"filename": "pynibs-0.2023.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bec9744cee33e9c0053b7d9a40a58bcd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2175459,
"upload_time": "2023-08-24T10:54:21",
"upload_time_iso_8601": "2023-08-24T10:54:21.753950Z",
"url": "https://files.pythonhosted.org/packages/ff/6d/2ea16fc6c2245bd5d6deb258f129de3b44dbd3bdf243d1de40ea7c5c1fa4/pynibs-0.2023.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7e1b262c4a2b18c35d589ccad558cc8aebdc335265dc0fcd4ef8ea53d70de9c9",
"md5": "ded066f525779efb0de0573d11c580e3",
"sha256": "ac555c1c50a6a0932a149629636951352ed2926f7d6dc95accc93cf7d4c993a0"
},
"downloads": -1,
"filename": "pynibs-0.2023.8.tar.gz",
"has_sig": false,
"md5_digest": "ded066f525779efb0de0573d11c580e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 2140635,
"upload_time": "2023-08-24T10:54:25",
"upload_time_iso_8601": "2023-08-24T10:54:25.547470Z",
"url": "https://files.pythonhosted.org/packages/7e/1b/262c4a2b18c35d589ccad558cc8aebdc335265dc0fcd4ef8ea53d70de9c9/pynibs-0.2023.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-24 10:54:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pynibs"
}