Installation

lussac is a python package that needs to be installed. It is recommended to install lussac in an environment, such as conda:

conda create -n lussac python=3.11  # Must be >=3.10
conda activate lussac

🕸️ Installing from PyPi

You can install lussac directly from PyPi using pip:

pip install lussac
# pip install --upgrade lussac  # To upgrade in case a new version is released.

🏗️ Installing from source

You can install lussac from source by cloning the GitHub repository (developmental version). This will ensure you have the latest updates, but some features might still be experimental!

# Download Lussac in any directory you want.
git clone https://github.com/BarbourLab/lussac.git --branch dev
cd lussac

# Install Lussac.
pip install -e .[dev]

# For the developmental version, you will likely need the latest developmental version of SpikeInterface
git clone https://github.com/SpikeInterface/spikeinterface.git
cd spikeinterface
pip install -e .

# If you want to check whether the installation was successful (optional)
pytest