| Name | pte JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | An open-source software package for working with electrophysiological data |
| upload_time | 2024-02-26 09:50:54 |
| maintainer | Richard M. Köhler |
| docs_url | None |
| author | Richard M. Köhler |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) [2021-2022] [authors of PTE] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
dbs
ecog
eeg
ieeg
lfp
neurophysiology
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[![Python Versions][python-shield]][python-url] [![PyPi][pypi-shield]][pypi-url]
[![License][license-shield]][license-url]
[![Contributors][contributors-shield]][contributors-url]
[![Code Style][codestyle-shield]][codestyle-url]
# PTE - Python tools for electrophysiology
PTE is an open-source software package for working with electrophysiological
data
PTE builds upon the packages [MNE](https://mne.tools/stable/index.html) and
[MNE-BIDS](https://mne.tools/mne-bids/stable/index.html).
## Installing PTE
### Stable release
To install the latest stable release, simply type:
```bash
$ pip install pte
```
### Development version
To install the latest development version, first clone this repository using
[git](https://git-scm.com/):
```bash
$ git clone https://github.com/richardkoehler/pte
```
Use the package manager
[conda](https://docs.conda.io/projects/conda/en/latest/index.html) to set up a
new working environment. To do so navigate to the PTE root directory in your
terminal and type:
```bash
$ conda env create -f env.yml
```
This will set up a new conda environment called `pte`.
To activate the environment then type:
```bash
$ conda activate pte
```
If you want to install pte-stats into another existing environment, type:
```bash
$ pip install -e .
```
## Usage
```python
import pte
```
## Contributing
Please feel free to contribute yourselves or to open an **issue** when you
encounter a bug or would like to add a new feature.
For any minor additions or bugfixes, you may simply create a **pull request**.
For any major changes, make sure to open an **issue** first. When you then
create a pull request, be sure to **link the pull request** to the open issue in
order to close the issue automatically after merging.
To contribute yourselves, consider installing the full conda development
environment to include such tools as black, pylint and isort:
```bash
$ conda env create -f env_dev.yml
$ conda activate pte-dev
```
Continuous Integration (CI) including automated testing are set up.
## License
PTE is licensed under the [MIT license](license-url).
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[python-shield]:
https://img.shields.io/static/v1?label=Python&message=3.10&logoColor=black&labelColor=grey&color=blue
[python-url]: https://pypi.org/project/pte-stats/
[contributors-shield]:
https://img.shields.io/github/contributors/richardkoehler/pte.svg?
[contributors-url]: https://github.com/richardkoehler/pte/graphs/contributors
[license-shield]:
https://img.shields.io/static/v1?label=License&message=MIT&logoColor=black&labelColor=grey&color=yellow
[license-url]: https://github.com/richardkoehler/pte/blob/main/LICENSE/
[codestyle-shield]:
https://img.shields.io/static/v1?label=CodeStyle&message=black&logoColor=black&labelColor=grey&color=black
[codestyle-url]: https://github.com/psf/black
[pypi-shield]:
https://img.shields.io/static/v1?label=PyPi&message=v0.1.0&logoColor=black&labelColor=grey&color=blue
[pypi-url]: https://pypi.org/project/pte/
Raw data
{
"_id": null,
"home_page": "",
"name": "pte",
"maintainer": "Richard M. K\u00f6hler",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "dbs,ecog,eeg,ieeg,lfp,neurophysiology",
"author": "Richard M. K\u00f6hler",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/cb/d4/979a429eb270a3ea238076cb608212d60430356cf2ae0ac338b59abca3ff/pte-0.2.0.tar.gz",
"platform": null,
"description": "[![Python Versions][python-shield]][python-url] [![PyPi][pypi-shield]][pypi-url]\n[![License][license-shield]][license-url]\n[![Contributors][contributors-shield]][contributors-url]\n[![Code Style][codestyle-shield]][codestyle-url]\n\n# PTE - Python tools for electrophysiology\n\nPTE is an open-source software package for working with electrophysiological\ndata\n\nPTE builds upon the packages [MNE](https://mne.tools/stable/index.html) and\n[MNE-BIDS](https://mne.tools/mne-bids/stable/index.html).\n\n## Installing PTE\n\n### Stable release\n\nTo install the latest stable release, simply type:\n\n```bash\n$ pip install pte\n```\n\n### Development version\n\nTo install the latest development version, first clone this repository using\n[git](https://git-scm.com/):\n\n```bash\n$ git clone https://github.com/richardkoehler/pte\n```\n\nUse the package manager\n[conda](https://docs.conda.io/projects/conda/en/latest/index.html) to set up a\nnew working environment. To do so navigate to the PTE root directory in your\nterminal and type:\n\n```bash\n$ conda env create -f env.yml\n```\n\nThis will set up a new conda environment called `pte`.\n\nTo activate the environment then type:\n\n```bash\n$ conda activate pte\n```\n\nIf you want to install pte-stats into another existing environment, type:\n\n```bash\n$ pip install -e .\n```\n\n## Usage\n\n```python\nimport pte\n```\n\n## Contributing\n\nPlease feel free to contribute yourselves or to open an **issue** when you\nencounter a bug or would like to add a new feature.\n\nFor any minor additions or bugfixes, you may simply create a **pull request**.\n\nFor any major changes, make sure to open an **issue** first. When you then\ncreate a pull request, be sure to **link the pull request** to the open issue in\norder to close the issue automatically after merging.\n\nTo contribute yourselves, consider installing the full conda development\nenvironment to include such tools as black, pylint and isort:\n\n```bash\n$ conda env create -f env_dev.yml\n$ conda activate pte-dev\n```\n\nContinuous Integration (CI) including automated testing are set up.\n\n## License\n\nPTE is licensed under the [MIT license](license-url).\n\n<!-- MARKDOWN LINKS & IMAGES -->\n<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->\n\n[python-shield]:\n https://img.shields.io/static/v1?label=Python&message=3.10&logoColor=black&labelColor=grey&color=blue\n[python-url]: https://pypi.org/project/pte-stats/\n[contributors-shield]:\n https://img.shields.io/github/contributors/richardkoehler/pte.svg?\n[contributors-url]: https://github.com/richardkoehler/pte/graphs/contributors\n[license-shield]:\n https://img.shields.io/static/v1?label=License&message=MIT&logoColor=black&labelColor=grey&color=yellow\n[license-url]: https://github.com/richardkoehler/pte/blob/main/LICENSE/\n[codestyle-shield]:\n https://img.shields.io/static/v1?label=CodeStyle&message=black&logoColor=black&labelColor=grey&color=black\n[codestyle-url]: https://github.com/psf/black\n[pypi-shield]:\n https://img.shields.io/static/v1?label=PyPi&message=v0.1.0&logoColor=black&labelColor=grey&color=blue\n[pypi-url]: https://pypi.org/project/pte/\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2021-2022] [authors of PTE] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "An open-source software package for working with electrophysiological data",
"version": "0.2.0",
"project_urls": {
"bugtracker": "https://github.com/richardkoehler/pte/issues",
"changelog": "https://github.com/richardkoehler/pte/blob/main/docs/CHANGELOG.md",
"repository": "https://github.com/richardkoehler/pte"
},
"split_keywords": [
"dbs",
"ecog",
"eeg",
"ieeg",
"lfp",
"neurophysiology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "860e9fea4ba53e96500602ed60de8b3cc93cce650c8f504d4f8943232e36ce96",
"md5": "39804a01c2e43312ad57da8e455e957c",
"sha256": "c02d67754ed7ac00d963833fa52dc218bafc0132bee948f4cfbc6e7ebc6bbdfe"
},
"downloads": -1,
"filename": "pte-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39804a01c2e43312ad57da8e455e957c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8398968,
"upload_time": "2024-02-26T09:50:51",
"upload_time_iso_8601": "2024-02-26T09:50:51.551040Z",
"url": "https://files.pythonhosted.org/packages/86/0e/9fea4ba53e96500602ed60de8b3cc93cce650c8f504d4f8943232e36ce96/pte-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cbd4979a429eb270a3ea238076cb608212d60430356cf2ae0ac338b59abca3ff",
"md5": "43ceb2d16b08cbc3012b2be2288a572d",
"sha256": "bf213e7aa13e6c37a855626f27349a405ee1f3fe6e96611e61209315ebca4a51"
},
"downloads": -1,
"filename": "pte-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "43ceb2d16b08cbc3012b2be2288a572d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 8377815,
"upload_time": "2024-02-26T09:50:54",
"upload_time_iso_8601": "2024-02-26T09:50:54.548963Z",
"url": "https://files.pythonhosted.org/packages/cb/d4/979a429eb270a3ea238076cb608212d60430356cf2ae0ac338b59abca3ff/pte-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 09:50:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "richardkoehler",
"github_project": "pte",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pte"
}
