Add Rica integration for interactive ICA component visualization #1288
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Closes #1283.
This PR adds the ability to generate Rica interactive reports directly from tedana output directories. Rica is a web-based visualization tool for exploring ICA components.
New Features
tedana/rica.pymodule for Rica download and report generation--rica-reportflag totedanaandica_reclassifyworkflowsopen_rica_report.pylauncher script in output directoryHow It Works
When
--rica-reportis passed to tedana or ica_reclassify:Download & Cache: Rica files are downloaded from ME-ICA/rica GitHub releases and cached in a platform-specific directory:
~/.cache/tedana/rica~/Library/Caches/tedana/rica%LOCALAPPDATA%/tedana/ricaCopy to Output: Rica files (
index.html,rica_server.py,favicon.ico) are copied tooutput_dir/rica/Generate Launcher: A cross-platform launcher script (
open_rica_report.py) is created in the output directoryVisualize: Users run the launcher script to start a local server and open Rica in their browser
Usage
The launcher script:
This PR depends on Rica v2.0.0 being released with build assets.
The Rica repository needs to:
modernize-app-performancebranch (which includes the GitHub Actions workflow for creating releases with build assets)v2.0.0tag to trigger the releaseUntil then, the
--rica-reportflag will show a warning that Rica could not be downloaded. Users can still use the standard HTML report.Testing
Test Plan
--rica-reportflag and verify Rica files are downloadedopen_rica_report.pyopens Rica correctly🤖 Generated with Claude Code