pte-stats 0.1.0

An open-source software package for statistics with time series.

PTE Stats - Python tools for electrophysiology

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

It builds upon PTE and provides statistical tools for time-series. PTE Stats is particularly useful with intracranial EEG (iEEG) data such as local field potentials (LFP) and electrocorticography (ECoG).

Installing pte-stats

First, get the current development version of pte-stats using git. Type the following command into a terminal:

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

Use the package manager conda to set up a new working environment. To do so navigate to the pte-stats root directory in your terminal and type:

conda env create -f env.yml

This will set up a new conda environment called pte-stats.

To activate the environment then type:

conda activate pte-stats

Finally, to install pte-stats in an editable development version inside your conda enviroment type the following inside the pte-stats root directory:

conda develop .

Usage

import pte_stats

# Examples

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:

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

Continuous Integration (CI) including automated testing are set up.

License

PTE Stats is licensed under the MIT license.