Installation
Requirements
Python 3.10+
pip (or any PEP 517 installer)
Install from PyPI
pip install ecogpy
This pulls in the core dependencies (numpy, scipy, pandas, xarray, scikit-learn) and is enough for filtering, spectral analysis, event detection, and spatial measures.
Extras
cogpy uses optional dependency groups so you only install what you need:
Extra |
What it adds |
When you need it |
|---|---|---|
|
matplotlib, seaborn, plotly, holoviews, panel, hvplot |
Plotting and interactive visualization |
|
h5py, tables, zarr, openpyxl, xmltodict |
Reading/writing HDF5, Zarr, Excel, XML formats |
|
ipykernel, ipywidgets |
Running cogpy inside Jupyter notebooks |
|
ghostipy, scikit-image, emd |
Advanced signal processing (e.g. EMD, morphological filtering) |
|
dask, pyfftw |
Parallel computation and faster FFTs |
|
mne |
Interoperability with MNE-Python |
|
All of the above (except |
Full install for development or exploration |
Install one or more extras with bracket syntax:
pip install "ecogpy[viz]" # just visualization
pip install "ecogpy[viz,io]" # visualization + file I/O
pip install "ecogpy[all]" # everything (except MNE)
pip install "ecogpy[all,interop-mne]" # truly everything
Development install
Clone the repo and install in editable mode:
git clone https://github.com/arashshahidi1997/cogpy.git
cd cogpy
pip install -e ".[all]"
This lets you edit source files and see changes immediately without reinstalling.
Verify
python -c "import cogpy; print(cogpy.__version__)"
You should see the installed version (e.g. 0.1.2).
Next steps
Quickstart — load data, compute a PSD, detect events