Data Loading in the Web App (All Paths)#
These pages cover the end-to-end ways to get data into Cellucid (pre-exported folders, browser file picker, server mode, and Jupyter).
They are written for mixed audiences:
Wet lab / non-technical: click-by-click, “what success looks like”, and safe defaults.
Computational users: formats, performance tradeoffs, parameter choices, and reproducibility.
Power users / developers: edge cases, failure modes, and how to debug loading issues.
Important
If you are not sure which method to use, start with Data Loading Overview (All 14 Options).
Note
Vector fields (velocity/drift overlays): if your dataset includes per-cell vectors, Cellucid can visualize them as an animated overlay after loading. You don’t need a special loading method—just make sure the vector field data is present and named correctly. See Vector Field / Velocity Overlay (GPU Particle Overlay) and Folder / file format expectations (high-level; link to spec).
Fast Path (Choose Your Workflow)#
Use this as a decision tree. You can always switch later.
You have… |
Best first choice |
Why |
Next page |
|---|---|---|---|
A pre-exported folder from |
Browser folder picker |
Fastest, most reliable, no server |
|
A |
Server mode (recommended) or Jupyter |
Lazy loading for large files, fewer browser memory issues |
|
A |
Server mode or Jupyter |
Chunked storage works well with lazy loading |
|
An in-memory |
Jupyter |
Fastest way to iterate while analyzing |
|
A dataset you want to share publicly |
GitHub-hosted exports |
Shareable URL, no server needed |
|
Screenshot Placeholder (You Will Replace Later)#
Use Dataset Connections to load data from your computer, a server, or a public GitHub repo.#
Getting Started#
Understand all 14 loading options and choose the best approach for your workflow: in-memory, h5ad, zarr, or pre-exported.
Export once, then share via public GitHub-hosted exports (no server), or run a local demo viewer.
Viewing Methods#
Load datasets directly from your file system using the browser’s native file picker API.
Run a local HTTP server for larger datasets with efficient lazy loading of gene expression.
Visualize AnnData objects directly within Jupyter notebooks with embedded interactive widgets.
Concepts & Troubleshooting#
What makes a dataset “the same dataset” in Cellucid, and why it matters for sessions, sharing, and community annotation.
What files/keys are required for exports, GitHub manifests, .h5ad, and .zarr.
Symptom → diagnosis → fix for file picker, server mode, GitHub exports, and common data issues.
One place to capture all screenshots referenced in this section.
If your dataset includes vector fields (e.g. RNA velocity), enable the overlay after loading and pick a field for the current dimension.
Quick Comparison#
Method |
Best For |
Requires Server |
|---|---|---|
Local Demo |
Quick visualization, sharing static files |
No |
File Picker |
Desktop viewing without setup |
No |
Server Mode |
Large datasets, lazy gene loading |
Yes |
Jupyter |
Interactive analysis workflows |
No |
Note
“Requires Server” here means “you run a small local Python process that serves data to the web viewer”.
This is still typically local-only (e.g. 127.0.0.1) unless you explicitly bind to 0.0.0.0.
Tip
Adding more pages:
Add new pages into
cellucid-python/docs/user_guide/web_app/b_data_loading/.Use a numeric prefix like
10_...so they naturally sort.This page includes them automatically via a globbed toctree.