Installation#

Prerequisites#

NeuRodent requires Python 3.10 or higher. If you don’t have Python installed, visit python.org to download and install it.

To check if Python is installed on your system, open a terminal (Command Prompt on Windows, Terminal on macOS/Linux) and run:

python --version

Quick Installation#

Install NeuRodent using pip:

pip install neurodent

Note

New to Python? Pip is Python’s package installer that comes bundled with Python. Open your terminal and copy-paste the command above, then press Enter. This will automatically download and install NeuRodent and all its dependencies.

Verifying Installation#

To verify that NeuRodent is installed correctly, open a Python interpreter by typing python in your terminal, then try importing neurodent:

import neurodent
print(neurodent.__version__)

If this runs without errors, you’re ready to start using NeuRodent!

Installing with uv#

Though not required, we recommend using uv, a Python package and project manager that’s faster than pip and handles virtual environments automatically.

Tip

Why use uv? uv is an all-in-one tool that simplifies Python development by handling:

  • Virtual environment creation and management - Automatically creates isolated environments for each project

  • Package management - Installs and manages dependencies faster than pip

  • Python version management - Can install and switch between different Python versions

  • Dependency resolution - Ensures all packages work together without conflicts

Learn more about uv’s features here.

First, install uv by following the instructions at docs.astral.sh/uv.

Then create a new project with NeuRodent:

uv init yourprojectname
cd yourprojectname
uv add neurodent

This creates a new directory, sets up a virtual environment, and installs NeuRodent—all in one go.

Next Steps#

Check out the Quickstart guide to learn how to use NeuRodent for EEG analysis.