Skip to content

1. Installation

mayofaulkner edited this page Sep 14, 2021 · 13 revisions

IBL users installation instructions


1. Install unified IBL python environment

Follow these instructions https://github.com/int-brain-lab/iblenv to install a unified environment that is compatible with all IBL libraries being developed

2. Setup IBL credentials

Follow these instructions to configure ONE and Datajoint credentials that give automatic access to IBL data

3. Launching the GUI

The ephys alignment gui can be launched from a python terminal using the following commands

conda activate iblenv
# path to the ephys_atlas_gui.py file on your computer
python int-brain-lab\iblapps\atlaselectrophysiology\ephys_atlas_gui.py 

A window containing blank plots should appear. Please refer to the Usage instructions for how to load data and start using the GUI.

External users installation instructions


1. Create compatible python environment

First start by installing the latest version of Anaconda 64 bit and Git if not already installed

In an anaconda prompt type the following commands

mkdir int-brain-lab
cd int-brain-lab

git clone https://github.com/int-brain-lab/ibllib.git --branch develop ibllib-repo
git clone https://github.com/int-brain-lab/iblapps.git  --branch develop
git clone https://github.com/int-brain-lab/iblenv.git
git clone https://github.com/cortex-lab/phylib

conda env create -f ./iblenv/iblenv.yaml
conda activate iblenv
conda develop ./ibllib-repo
conda develop ./iblapps
conda develop ./phylib

2. Prepare Data for GUI

Please refer to the section Preparing data for ephys GUI for instructions of how to prepare your data in the correct format to be read in by the GUI

We have also provided a sample data set so you can quickly get started and try out the tool. The data is stored in the ephys_alignment_sample_data.zip folder and can be downloaded from here

3. Launching the GUI

The ephys alignment GUI can be launched from a python terminal using the following commands

conda activate iblenv
# path to the ephys_atlas_gui.py file on your computer
python int-brain-lab\iblapps\atlaselectrophysiology\ephys_atlas_gui.py -o True 

The -o True argument is important to indicate that you are using the alignment GUI in non IBL mode

A window containing blank plots should appear. Please refer to the Usage instructions for how to load data and start using the GUI.

Clone this wiki locally