Skip to content

Install cicada-analysis

Installing cicada-analysis also installs cicada-nwb. Python 3.11 or later. To also get the desktop application, install cicada-gui instead.

The latest release:

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"

Upgrade

From PyPI, the latest release:

conda activate cicada_env
pip install -U cicada-analysis

Or from GitLab, a given release: replace the tag with its version (check available releases on GitLab):

conda activate cicada_env
pip install "git+https://gitlab.com/cossartlab/cicada_analysis.git@<new_version>"

To work on the CICADA code itself (from a clone): 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.

Then: Quick start.