richardkoehler / pte

An open-source software package for working with electrophysiological data.

PTE - Python tools for electrophysiology

PTE is an open-source software package for working with electrophysiological data

PTE builds upon the packages MNE and MNE-BIDS.

Installing PTE

Stable release

To install the latest stable release, simply type:

$ pip install pte

Development version

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

$ git clone https://github.com/richardkoehler/pte

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

$ conda env create -f env.yml

This will set up a new conda environment called pte.

To activate the environment then type:

$ conda activate pte

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

$ pip install -e .

Usage

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:

$ 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.