Installation¶

PyTorch¶

vneurotk requires PyTorch, but does not install it automatically to allow you to choose the version that matches your hardware. Install PyTorch before installing this package:

# uv（auto CUDA version detect）
uv pip install torch --torch-backend=auto

Stable release¶

To install vneurotk:

uv add vneurotk

Or if you prefer pip, just replace uv with pip install:

pip install vneurotk

Optional dependencies¶

uv add "vneurotk[mne]"          # M/EEG analysis: mne, mne-bids
uv add "vneurotk[notebook]"     # Jupyter: ipykernel, ipywidgets
uv add "vneurotk[timm]"         # timm models
uv add "vneurotk[thingsvision]" # thingsvision
uv add "vneurotk[cebra]"        # CEBRA

Multiple extras can be installed at once:

uv add "vneurotk[meg,notebook]"

From source¶

git clone https://github.com/colehank/vneurotk

Once you have a copy of the source, you can install it with:

cd vneurotk
uv pip install torch --torch-backend=auto
uv sync

For contributors¶

Clone and set up the development environment:

git clone https://github.com/colehank/vneurotk.git
cd vneurotk
uv pip install torch --torch-backend=auto
uv sync  # core only

Available additionals:

To sync

uv sync --group dev      # dev tools
uv sync --extra mne      # MEG analysis
uv sync --extra notebook # Jupyter support

To sync groups/extras at once:

uv sync --group dev --extra mne --extra notebook