Install From Command Line

This page describes how to install SanPy from the command-line.

If you want to download and run SanPy as a pre-built desktop application, please see our easy to follow download sanpy page.

Install from the command line¤

Create and activate a virtual environment with either conda or venv.

Important

M1/2 Mac users need to use a Conda environment as the arm64 versions of a number of Python packages are not available on PyPi (e.g. with pip install).

Either create a `conda` environment¤

conda create -y -n sanpy-env python=3.9
conda activate sanpy-env

Or create a `venv` environment¤

python -m venv sanpy-env

# macOS activate the environment
source sanpy-env/bin/activate

# Windows activate the environment
sanpy-env\Scripts\activate

Install SanPy from PyPi ¤

Important

The SanPy package is named sanpy-ephys.

pip install "sanpy-ephys[gui]"

Run the GUI¤

sanpy

Install from a local source¤

For users interested in modifying the source code, you can clone the GitHub repository and install from local source.

Be sure to create and activate a virtual environment (See above).

Assuming you have the following

1) Clone the repository

git clone https://github.com/cudmore/SanPy.git

2) Install SanPy

cd SanPy
pip install -e ".[gui]"

4) Run sanpy

sanpy

5) Have fun