CICADA: analysis of NWB neurophysiology data¶
CICADA is an open-source Python pipeline to analyse neurophysiology data stored in NWB files: two-photon calcium imaging, extracellular electrophysiology, widefield imaging and behaviour. It is listed among the NWB community tools.
You pick the NWB files to analyse (on your disk or on DANDI), choose an analysis, set its parameters and run it. CICADA writes the figures and result files and a record of the run, so it can be replayed with the same data and parameters.
What it does¶
- Ready-made analyses. Plugins for activity rasters, cell maps, peri-event time histograms (calcium, spikes, behaviour), activity statistics, pairwise correlations, connectivity graphs, assemblies and sequences, and more. See the plugin catalogue.
- Any NWB file that follows the standard. The analyses read the data through standard NWB types, so they work on files from any lab, including public datasets.
- GUI or scripts, same results. The desktop application and the headless runner use the same plugins and the same parameter files. A parameter set prepared in the GUI runs unchanged on a server.
- Replayable runs. Every run writes a
combined_<Analysis>_<timestamp>.yamlwith the files, the analysis and every parameter value. Passing it back to the runner reproduces the run. - Data on DANDI. Files can be streamed or downloaded from the DANDI archive by their address, without downloading the dandiset first.
- Extendable. New analyses are plugins: a Python class with its parameters, a data check and the computation. Lab-specific data conventions go in lab submodules.
Three packages¶
CICADA is split into three Python packages. Each one is an entry point and installs the ones below it.
| Package | What it is | Use it to |
|---|---|---|
| cicada-gui | Desktop application (Qt) | Browse sessions, set parameters in forms, run analyses and look at the results |
| cicada-analysis | Analysis engine, plugins and the cicada-tools library |
Run analyses from YAML files or Python scripts, write new plugins |
| cicada-nwb | Read-only access to NWB files | Read NWB data in your own code |
See Architecture for how they fit together.
Where to go next¶
- Get started: choose a package and install it.
- Data sources: local files or DANDI.
- Demo: try CICADA on the small example files installed with it.
Citing CICADA¶
If you use CICADA, please cite the bioRxiv preprint.