pte-stats


Namepte-stats JSON
Version 0.3.0 PyPI version JSON
download
home_page
SummaryAn open-source software package for statistics with time series.
upload_time2024-02-15 18:27:29
maintainerRichard M. Köhler
docs_urlNone
authorRichard M. Köhler
requires_python>=3.10
licenseMIT License Copyright (c) [2021-2022] [authors of PTE Stats] 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 eeg ieeg statistics timeseries
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]
[![Tests][tests-shield]][tests-url] [![License][license-shield]][license-url]
[![Contributors][contributors-shield]][contributors-url]
[![Code Style][codestyle-shield]][codestyle-url]

# PTE Stats - Python tools for electrophysiology

PTE Stats is an open-source software package for statistics with time series.

It builds upon [PTE](https://github.com/richardkoehler/pte) and provides
statistical tools for time-series. PTE Stats is particularly useful with
intracranial EEG data such as local field potentials and electrocorticography.

## Installing pte-stats

### Stable release

To install the latest stable release, simply type:

```bash
$ pip install pte-stats
```

### Development version

To install the latest development version, first clone this repository:

```bash
$ git clone https://github.com/richardkoehler/pte-stats
```

If you are using conda, simply run:

```bash
$ conda env create -f env.yml
$ conda activate pte-stats
```

If you want to install pte-stats into an existing environment, type:

```bash
$ pip install -e .
```

## Usage

```python
import pte_stats
```

## Contributing

Please feel free to contribute yourselves or to open an **issue** when you
encounter a bug or to request 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.

### How to contribute

To contribute yourselves, you should fork this repository, and then create a
development branch from your fork.

Then, inside your development branch run the commands:

```bash
$ conda env create -f env_dev.yml
$ conda activate pte-stats-dev
```

... or simply:

```bash
$ pip install -e .[dev]
```

This will additionally install packages for development, such as black, pylint,
mypy and isort.

## License

PTE Stats 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.12&logoColor=black&labelColor=grey&color=blue
[python-url]: https://pypi.org/project/pte-stats/
[pypi-shield]:
  https://img.shields.io/static/v1?label=PyPi&message=v0.3.0&logoColor=black&labelColor=grey&color=blue
[pypi-url]: https://pypi.org/project/pte-stats/
[tests-shield]:
  https://github.com/richardkoehler/pte-stats/actions/workflows/main.yml/badge.svg
[tests-url]:
  https://github.com/richardkoehler/pte-stats/actions/workflows/main.yml
[contributors-shield]:
  https://img.shields.io/github/contributors/richardkoehler/pte-stats.svg
[contributors-url]:
  https://github.com/richardkoehler/pte-stats/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-stats/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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pte-stats",
    "maintainer": "Richard M. K\u00f6hler",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "eeg,ieeg,statistics,timeseries",
    "author": "Richard M. K\u00f6hler",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/35/5b/898c13d8cae3d897d5dd3b0a05ef7de6ad7f75ef549efd1ccef2bbd9835f/pte_stats-0.3.0.tar.gz",
    "platform": null,
    "description": "[![Python Versions][python-shield]][python-url] [![PyPi][pypi-shield]][pypi-url]\n[![Tests][tests-shield]][tests-url] [![License][license-shield]][license-url]\n[![Contributors][contributors-shield]][contributors-url]\n[![Code Style][codestyle-shield]][codestyle-url]\n\n# PTE Stats - Python tools for electrophysiology\n\nPTE Stats is an open-source software package for statistics with time series.\n\nIt builds upon [PTE](https://github.com/richardkoehler/pte) and provides\nstatistical tools for time-series. PTE Stats is particularly useful with\nintracranial EEG data such as local field potentials and electrocorticography.\n\n## Installing pte-stats\n\n### Stable release\n\nTo install the latest stable release, simply type:\n\n```bash\n$ pip install pte-stats\n```\n\n### Development version\n\nTo install the latest development version, first clone this repository:\n\n```bash\n$ git clone https://github.com/richardkoehler/pte-stats\n```\n\nIf you are using conda, simply run:\n\n```bash\n$ conda env create -f env.yml\n$ conda activate pte-stats\n```\n\nIf you want to install pte-stats into an existing environment, type:\n\n```bash\n$ pip install -e .\n```\n\n## Usage\n\n```python\nimport pte_stats\n```\n\n## Contributing\n\nPlease feel free to contribute yourselves or to open an **issue** when you\nencounter a bug or to request 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\n### How to contribute\n\nTo contribute yourselves, you should fork this repository, and then create a\ndevelopment branch from your fork.\n\nThen, inside your development branch run the commands:\n\n```bash\n$ conda env create -f env_dev.yml\n$ conda activate pte-stats-dev\n```\n\n... or simply:\n\n```bash\n$ pip install -e .[dev]\n```\n\nThis will additionally install packages for development, such as black, pylint,\nmypy and isort.\n\n## License\n\nPTE Stats 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.12&logoColor=black&labelColor=grey&color=blue\n[python-url]: https://pypi.org/project/pte-stats/\n[pypi-shield]:\n  https://img.shields.io/static/v1?label=PyPi&message=v0.3.0&logoColor=black&labelColor=grey&color=blue\n[pypi-url]: https://pypi.org/project/pte-stats/\n[tests-shield]:\n  https://github.com/richardkoehler/pte-stats/actions/workflows/main.yml/badge.svg\n[tests-url]:\n  https://github.com/richardkoehler/pte-stats/actions/workflows/main.yml\n[contributors-shield]:\n  https://img.shields.io/github/contributors/richardkoehler/pte-stats.svg\n[contributors-url]:\n  https://github.com/richardkoehler/pte-stats/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-stats/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",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) [2021-2022] [authors of PTE Stats]  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 statistics with time series.",
    "version": "0.3.0",
    "project_urls": {
        "bugtracker": "https://github.com/richardkoehler/pte-stats/issues",
        "changelog": "https://github.com/richardkoehler/pte-stats/blob/main/docs/CHANGELOG.md",
        "repository": "https://github.com/richardkoehler/pte-stats"
    },
    "split_keywords": [
        "eeg",
        "ieeg",
        "statistics",
        "timeseries"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7819eb4b0c30e792d6850de2af639dfa0f22b9b68c1dfb46e34daa69da74cb1a",
                "md5": "fa987789dff447bb6de0ac31d4f6cf45",
                "sha256": "dc8fa93034ac4a22872e7f9d3ef05f943d65c257b6c803a95cb4da0d06d74389"
            },
            "downloads": -1,
            "filename": "pte_stats-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fa987789dff447bb6de0ac31d4f6cf45",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 11159,
            "upload_time": "2024-02-15T18:27:26",
            "upload_time_iso_8601": "2024-02-15T18:27:26.038777Z",
            "url": "https://files.pythonhosted.org/packages/78/19/eb4b0c30e792d6850de2af639dfa0f22b9b68c1dfb46e34daa69da74cb1a/pte_stats-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "355b898c13d8cae3d897d5dd3b0a05ef7de6ad7f75ef549efd1ccef2bbd9835f",
                "md5": "15c19888c888709892e37b5c46b6e369",
                "sha256": "752f2238483c6ed2979ee935975c83c75848e8d55a7cd687b47afd027e101ab1"
            },
            "downloads": -1,
            "filename": "pte_stats-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "15c19888c888709892e37b5c46b6e369",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 15370,
            "upload_time": "2024-02-15T18:27:29",
            "upload_time_iso_8601": "2024-02-15T18:27:29.278168Z",
            "url": "https://files.pythonhosted.org/packages/35/5b/898c13d8cae3d897d5dd3b0a05ef7de6ad7f75ef549efd1ccef2bbd9835f/pte_stats-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-15 18:27:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "richardkoehler",
    "github_project": "pte-stats",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "pte-stats"
}
        
Elapsed time: 0.26753s