Skip to content

Get started

Install the package that matches how you want to work. Each package installs the ones it builds on: cicada-gui brings cicada-analysis, which brings cicada-nwb.

You want to Install Then read
Browse and select sessions by their metadata, try analyses and tune their parameters while looking at the results (exploration) cicada-gui GUI guide
Run the same analyses on many sessions or multiple analyses on a session group, as a batch from YAML files and scripts (servers and clusters included); replay a previous run cicada-analysis Headless workflow
Read NWB data in your own analysis code to develop new analysis plugins cicada-nwb cicada-nwb guide

The two first uses go together: explore and set the parameters in the GUI, save them, then run them headless on all your sessions.

CICADA needs Python 3.11 or later. The commands below use a conda environment; any virtual environment works.

Install

From PyPI:

conda create -n cicada_env python=3.11
conda activate cicada_env
pip install cicada-gui

Or from GitLab, a given release (tag):

conda create -n cicada_env python=3.11
conda activate cicada_env
pip install "git+https://gitlab.com/cossartlab/cicada_gui.git@0.4.0"

Then launch it:

conda activate cicada_env
python -m cicada_gui

From PyPI:

conda create -n cicada_env python=3.11
conda activate cicada_env
pip install cicada-analysis

Or from GitLab, a given release (tag):

conda create -n cicada_env python=3.11
conda activate cicada_env
pip install "git+https://gitlab.com/cossartlab/cicada_analysis.git@0.4.0"

cd 'path/to/'
conda create -n cicada_env python=3.11
conda activate cicada_env
pip install "git+https://gitlab.com/cossartlab/cicada_nwb.git@0.4.0"

These commands install the latest release, which includes the fixes made since the previous ones. Use an older tag only to reproduce results obtained with it (the version used for a run is recorded in its combined YAML). Releases are listed on GitLab: cicada_gui, cicada_analysis, cicada_nwb.

To write your own analysis plugins or a lab package, see Lab developers; to work on the CICADA code itself, see Core developers.

Windows: long paths

Windows limits file paths to 259 characters unless long paths are enabled. Some analyses write files in sub-folders with long names, so with a results folder deep in your tree, saving can fail ("No such file or directory"). CICADA warns at the start of a run when this may happen. To remove the limit, once, as administrator:

reg add HKLM\SYSTEM\CurrentControlSet\Control\FileSystem /v LongPathsEnabled /t REG_DWORD /d 1 /f

(or Local Group Policy Editor > Computer Configuration > Administrative Templates > System > Filesystem > Enable Win32 long paths), then restart. Otherwise, choose a results folder with a short path (e.g. C:\results). macOS and Linux have no such limit.

First steps

  1. Try an analysis on the example files installed with cicada-analysis: Demo.
  2. Point CICADA at your own files, or at files on DANDI: Data sources.
  3. Look through the available analyses: plugin catalogue.