Loading a combined YAML that records the sha256 of local input files (a run with hash_inputs=True) froze the window while each whole file was read again to check it. The input files are now checked when the run starts, in the run's thread; the warnings appear in the run's log as before.
Parameter values: a drop-down of numbers (e.g. the journal columns, 1 or 2) gave the run and the combined YAML the text shown ('2') instead of the number; it now gives the choice itself. A colour came back slightly changed (0.12 as 0.11999..., Qt keeps 16 bits per channel); a default colour or one read from a config is now passed as given, until another is picked.
Analysis window and overview of the analyses: the list of sessions next to the analysis name was cut at the width left by the name (e.g. "MH031_20250507_" for MH031_20250507_104425), with a horizontal scroll bar; it is now as wide as its longest session name.
Select group always offers Demo files: the demo NWB files shipped with cicada-analysis, loaded and selected in one click (the group cannot be deleted). Double-clicking an analysis with a single demo session ticked loads the parameters of its Figure 3 plot on that file, when there is one (e.g. the cells map on cossart_ophys_000219: panel A1); the window says which, and keeps its own results folder.
Documentation site pages (built from cicada-analysis): docs/index.md, install.md, quickstart.md and changelog.md take their text from the README (section markers <!-- --8<-- [start:...] -->, invisible on GitLab) and from this changelog. The README has a "What's inside" section. The GUI guide follows the workflow (load, select, pick an analysis, set parameters, run) with a workflow diagram, the main window layout, the DANDI menus and the analysis window tabs.
Parameters whose choices follow another parameter (choices_follow): the trial groups and the drop-down of their time column show the columns of the table chosen in "Table to use"; changing the table removes the groups using columns it does not have (the groups of a loaded config are kept). ParameterWidgetModel.follow_choices.
Parameters of the branches not chosen are hidden instead of greyed out (hide_when_unused), so the boxes only show what applies: the event source's parameters (PSTHs, Display activity / behavior), TIFF movie's frame range / around events, Display activity's data types, the cells map's colour modes and contours, the ephys PSTH's artifact source, seq Malvache's order source. Parameters not used that depend on a hidden one are hidden too; options waiting for a tick box stay greyed out.
File > Open new dataset from DANDI... and Add data from DANDI...: type a dandiset (000728, a dandiarchive.org link, a DOI, dandi://000728@<version>), a folder of it or one NWB file; the dialog lists the dandiset's NWB files with their sizes (nothing opened yet), with a filter (words, e.g. sub-4916 StimB), Tick / Untick shown and a count of the files and size ticked; choose how files are read (stream, download, auto) and only the ticked files are opened and listed as sessions. Files that cannot be opened are listed in a message. In download and auto modes, a "Download to" folder (Browse...; prefilled with the last folder chosen, else <Downloads folder>/cicada, the default of scripts and the command line; asked on Open if emptied): files go to <folder>/<dandiset>/<version>/<path> and are reused from there. The last address, mode and download folder are remembered (last_dandi_address, dandi_mode, dandi_download_dir in the user config).
When CICADA quits (main window closed), the sessions are closed and the DANDI stream chunk cache is deleted (~/Library/Caches/cicada/dandi/chunks on macOS; size freed printed). Downloaded DANDI files are kept.
Session groups (sessions YAML) may contain DANDI addresses: loading a group keeps them (before: entries not found on disk were skipped), and a file that fails to open is reported and skipped. Saved groups record the version-pinned address.
Analysis window: the bottom panel has three tabs. "Messages": the execution and error panels. "Results": the files of the run's results folder, updated while the run writes them, with a preview of images (PNG, JPG, TIFF, SVG), tables (CSV / TSV, first 500 rows) and text files (log, YAML); Open / Open folder (or double-click) opens them in their application. "Interactive viewing": the interactive figure files (.mplfig) of the results folder, written by every plugin when "Interactive viewing of the figures" is ticked (off by default), listed as they are written and drawn with the matplotlib toolbar (zoom, pan, save) at any format, PDF included; "Open in a window" (or double-click, here or in the Results tab) opens it in its own resizable window. Each figure is read from its file when selected: only the figure shown and those of the open windows are in memory, whatever the number of figures of the run. A file that cannot be read (e.g. written with another matplotlib version) shows a message. After a successful run the window shows Interactive viewing (or Results, without interactive figures). Figure windows close with the analysis window.
"Figure saving" group of the analysis window: one parameter per row (before: two side by side, which cut the labels of "Interactive viewing of the figures" and of the rasterizing option and needed a horizontal scroll bar). ONE_PER_ROW_FAMILIES in widget_factory.
Loading a combined YAML warns when an input file differs from the recorded run (identifier, size, sha256, DANDI version or asset ID), printed with the version warnings when the analysis runs. The version warnings now include cicada-gui, the Python version and uncommitted changes (development installs). Revision C5: installed packages outside the declared ranges, and parameter names the plugin does not have or missing from the file (params files too).
If writing the combined config after a run fails, the error panel says so (asking to report it) and the traceback goes to err.txt; before, the error was ignored and the run silently had no combined config.
New groups get the Okabe-Ito colours by default, one per group in turn (orange, sky blue, green, yellow, blue, vermillion, purple, black), the colours of the figures (before: matplotlib tab10).
A plugin error no longer closes the GUI: if opening an analysis fails (copy(), setup_parameters() or building its window), a message gives the error and the other analyses still work (traceback in the console). If a plugin's check_data() raises an exception (not when it returns False with its reason), the plugin is greyed out with the exception in its tooltip.
Plugins are found with the plugin registry of cicada-analysis: the installed packages declaring plugins (entry-point group cicada_analysis.plugins) instead of three hard-coded folders, plus the folders added in the Plugin Manager. The Plugin Manager groups plugins by package (core, cossart, petersen, "(installed package)") and lists the plugins that could not be loaded under "Not loaded" (before: only printed in the terminal).
"Group by" reads each factor through NWBSession.group_value (attribute paths such as petersen.session_type), so lab packages add grouping factors without changing cicada-nwb. New generic factors from cicada-nwb: cell types, one per kind of data, lab, institution, protocol, experimenter.
About window (Help > About): the links open the CICADA documentation (cicada-analysis.readthedocs.io) and the cicada-gui GitLab repository, instead of the readthedocs.org home page and the old GitHub repository.
User preferences (last folders, DANDI mode, plugin paths, hidden analyses) are stored in the user's config folder (~/Library/Application Support/cicada on macOS, %LOCALAPPDATA%\cicada\cicada on Windows, ~/.config/cicada on Linux) instead of inside the installed package, where they could not be saved in read-only installs and were lost at each upgrade. The old file is copied there on first start. If the folder cannot be written, preferences are kept for the session with a message instead of an error. New dependency platformdirs (already installed with cicada-nwb).
"Group by" (main window) only offers the factors that split the loaded sessions: at least one session has a value and the sessions fall in at least two groups. Lab-specific factors that every file answers with the same default label (e.g. "No CI on pause", "NS") are no longer offered. Updated each time files are loaded.
RUN with invalid parameters now shows a message listing every problem (missing mandatory values, plugin checks), instead of doing nothing. Parameters that need data none of the selected sessions has are no longer shown.
Parameters not used with the current values (e.g. "Downsampling factor" while "Downsample traces" is unchecked) are greyed out and faded, updated live as other parameters change; the tooltip gives the reason. The dark theme now has disabled styles for labels, check boxes, sliders, spin boxes, text fields and combo boxes.
Group selectors show the groups a plugin gives as default when they are created (e.g. PSTH single cell: cells '0-9'); before, defaults appeared only after "Reset".
Trial groups (PSTHs): each new group gets its own colour (before: white, invisible on light figures); the default name is the first free "Group n".
Groups of checked items with a colour (event groups, epoch groups, session groups, cell type and location groups): each new group gets its own colour too, in the same order as the trial groups (before: white).
Trial groups: "All" / "None" buttons next to the values of each column of the trial / epoch table (e.g. tick all, then untick the one value to leave out).
New widget for groups of typed indices (IndexGroupBuilderWidget, parameters declared with add_index_groups_for_gui, e.g. cell index groups): a name, the indices (red border while they do not read as indices), a colour and "Add group"; the groups are listed with a remove button.
"Load group" on a YAML whose session paths are relative (e.g. the demo configs demo/figure_configs/...) loaded no session and said nothing: the paths were read from the current folder. They are now resolved from the folder of the YAML file (cicada-analysis load_sessions_config), and a file not found is reported in the console. An empty group no longer divides by zero.
A run crashing at 0% (e.g. while creating its results folder) showed no red on the progress bar: only the filled part was red. The border and the "Crashed at n%" text are now red too.
The "Select path to yaml file" dialogs (behaviour plots, widefield error response) open again in the folder last chosen: the preferences, saved after it, overwrote it with their own copy.
Plugins drew their figures with matplotlib's Qt backend from the analysis thread, which creates Qt objects outside the GUI thread. The GUI now sets the non-interactive Agg backend at startup (figures are only saved, no window opens). matplotlib is now a declared dependency.
The analysis thread updated the execution and error panels directly, which Qt does not allow outside the GUI thread (likely cause of freezes, especially on macOS). The output now reaches the panels through Qt signals.
log.txt was rewritten in full at each print and also held the output of the window's previous runs; err.txt always missed the last message. Both now grow line by line with the output of their own run, including what is printed before the results folder exists.
A plugin crash skipped the end of the run: the results folder button and RUN stayed disabled, so the analysis could not be run again without closing its window. The crash is now caught, its traceback goes to the error panel and err.txt, the folder button and RUN are enabled, the window shows "Analysis crashed" and both progress bars (analysis window and overview) turn red, reading "Crashed at n%" where the run stopped. No combined YAML is written for a crashed run. A traceback printed by a plugin that goes on running no longer marks the run as crashed.
The analysis thread replaced the application's exception handler (sys.excepthook) at each run.
Overview panel: the results folder button of a re-run was added at the bottom, under the last opened analysis; it now goes under its own analysis' previous results buttons, and closing the analysis window removes it with them.
Parameter boxes kept the height they had when built: adding trial groups made the content scroll inside the box and the rows move. The box now follows its content (CollapsibleBox.refresh_height).
Trial groups: a second group with the same name silently replaced the first one in the analysis (one PSTH per name); "Add group" now refuses a name already used. Removing a group then adding one could create such a duplicate ("Group n" numbering).
Trial groups: loading a configuration without trial groups kept the groups already in the widget, which were then used by the run.
Chained choices (e.g. ROI response series: module, interface, series): choosing another first-level entry refilled the second box but not the next ones, which kept the choices of the first entry, so some series could not be selected (e.g. Allen DfOverFEvents, or any entry after a first one with other contents such as the background image's "none").
Closed analysis windows stayed in memory until CICADA quit (with their widgets and the plugin's copy, about 7.5 MB each on a small file): the analysis tree and the overview panel kept references to them. A closed window is now freed; the NWB sessions it used stay open for the other analyses. Answering "No" to "The analysis is still ongoing, do you still want to quit?" no longer removes the analysis from the overview panel when the window had run before.
Closing an analysis window during its run (answering "Yes") killed the analysis thread wherever it was, which could leave the shared NWB files locked for the other analyses. The run is now asked to stop: it ends after the step it is doing (usually the current session), its log says so and it writes no combined YAML; the window disappears and is freed then. Quitting CICADA during a run waits for the run to stop before closing the files; answering "No" keeps CICADA open (before, it quit anyway).
On screens narrower than 1200 pixels, analysis windows could not be opened ("cannot be opened: TypeError"), and below 825 pixels the GUI crashed at startup: the minimum widths of the analysis tree and the parameters panel were given as decimal numbers.
Packaging for PyPI: cicada-analysis is required by version range (cicada-analysis>=0.4.0.dev0,<0.5, >=0.4,<0.5 from the 0.4.0 release) instead of a GitLab URL; the cicada_gui_update command is removed (update with pip install -U cicada-gui, or git pull in a clone). Contributors install the clones from the bottom up: cicada-nwb, cicada-analysis, then cicada-gui (the README gives the commands).
Closing an analysis window (on crash, cancellation, or normal completion) no longer raises an error if the window was already removed from the tracked object list.
Removed a leftover debug print of the default value when building float parameter widgets.