[![Homepage][homepage-shield]][homepage-url]
PTE Decode is an open-source software package for neural decoding.
It builds upon PTE and aims at decoding intracranial EEG (iEEG) signals such as local field potentials (LFP) electrocorticography (ECoG).
PTE Decode implements sample-wise decoding and lets you define epochs based on specific events to avoid circular training.
First, get the current development version of PTE using git. Then type the following command into a terminal:
git clone https://github.com/richardkoehler/pte-decode
Use the package manager
conda to set up a
new working environment. To do so, use cd
in your terminal to navigate to the
PTE root directory and type:
conda env create -f env.yml
This will set up a new conda environment called pte-decode
.
To activate the environment then type:
conda activate pte-decode
Finally, to install PTE Decode in an editable development version inside your environment type the following inside the PTE Decode root directory:
pip install -e .
import pte_decode
# Examples
Please feel free to contribute.
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, 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-decode-dev
Continuous Integration (CI) including automated testing are set up.
PTE is licensed under the MIT license.