Skip to content

1. Installation

mayofaulkner edited this page Jul 26, 2022 · 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

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

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.

N.B. Some mac users using Big Sur OS have reported that the window does not appear upon executing the command above. If this is the case please refer to this section for a workaround

Clone this wiki locally