This release is a pre-release and may not be stable for production use.
VIPP — Visual Image Processing Platform
Design inspectable bioimage workflows with visual feedback at every stage.
Visual image processing made approachable through visual workflows for reproducible bioimage analysis.
VIPP is an open-source, napari-native platform for building bioimage analyses as visual graphs. Connect image, mask, label and table nodes, inspect parameters and intermediate results, compare processing routes on the same input, and then move from representative samples to collection-wide execution.
Build and run workflows from the available nodes without writing Python. Save them as versioned JSON, export them as Python, and retain the source, axes, calibration, parameters, outputs and implementation provenance needed to understand how results were produced.
Alpha software: workflows and parameters may still change. Validate every analysis on representative data before scientific interpretation or publication.
A calculated 3D deconvolution workflow with the node catalogue, thumbnail previews and selected-node inspector visible together.
Why VIPP
- See each transformation. Inspect images, histograms, tables, metadata and parameters while designing the workflow.
- Iterate locally. Recalculate one stage without repeatedly running every later step.
- Compare approaches. Apply different processing routes to the same input and inspect the consequences side by side.
- Check before scaling. Test representative samples before running the workflow across an image collection.
- Keep the analysis record. Save the graph, export Python, define batch outputs and preserve execution provenance.
- Accelerate selected operations. Dedicated GPU implementations are available for supported filtering, restoration, segmentation and measurement operations.
Install
For this version, use the
v0.15.0a5 release page.
| Platform | Recommended route |
|---|---|
| Windows 64-bit | Download VIPP-Setup-0.15.0a5-Windows-x86_64-UNSIGNED.exe from the release page. The setup application creates and manages a dedicated VIPP environment. A supported 64-bit Python is a separate prerequisite. |
| macOS Apple Silicon | Download VIPP-0.15.0a5-macOS-arm64-UNSIGNED.pkg. The package is self-contained and CPU-only. |
| macOS Intel | Download VIPP-0.15.0a5-macOS-x86_64-UNSIGNED.pkg. The package is self-contained and CPU-only. |
| Linux or an existing Python environment | Use the manual installation below. CPU execution is supported. |
The desktop installers are unsigned alpha builds. Download them only from the official release, verify the matching SHA-256 file, and follow the Quick Start for the exact platform instructions.
For a manual installation, use a dedicated CPython 3.12 or 3.13 environment. On Windows or Linux:
python -m pip install "napari[pyqt6]>=0.6" "napari-vipp==0.15.0a5"
vipp
On macOS, replace "napari[pyqt6]>=0.6" with "napari[pyside6]>=0.6".
The macOS route is CPU-only.
Inside an existing napari session, open:
Plugins > VIPP Workflow (napari-vipp)
Try A Bundled Workflow
No external data is needed for the first run:
- Launch VIPP, open the gear menu, and select Open example….
- Open Red-Channel Label Cleanup.
- Select the nodes from left to right. Inspect their parameters, previews, histograms, metadata and outputs.
- Change a parameter and compare the affected stages. Use Calculate where a computationally intensive node requires an explicit run.
- Pin an output into napari for full-resolution inspection, then save the workflow as JSON.
Next, open Deterministic Batch & Provenance for a self-contained example of collection processing and reproducibility artifacts. See the example workflow index for more starting points.
Analysis Coverage
| Goal | Available building blocks |
|---|---|
| Prepare images | Intensity transforms, background correction, filtering, denoising, channel handling, axis operations, masks and volume regions of interest. |
| Segment structures | Global and local thresholds, edges, watershed, binary morphology, label cleanup and connected-component operations. |
| Quantify results | Object and intensity measurements, calibrated 3D mesh morphology, skeleton and network analysis, colocalisation, object association and table composition. |
| Restore images | Measured or generated point-spread functions, Richardson–Lucy and RL–TV deconvolution in 2D and 3D. |
| Reuse analyses | Workflow JSON, generated Python, explicit batch outputs, collection manifests and execution provenance. |
VIPP reads OME-TIFF, ImageJ TIFF, TIFF, local OME-Zarr 0.4/0.5, NPY/NPZ and common 2D image formats. Optional readers add formats including ND2 and CZI. The I/O guide documents the complete matrix, metadata behavior and limitations.
Most graph operations currently materialize their inputs in memory. Plan cache, preview and output choices deliberately for large z-stacks and OME-Zarr data. See Cache and memory.
GPU Acceleration (Optional)
VIPP is fully usable on CPU on Windows, Linux and macOS. Selected computationally intensive operations offer dedicated GPU acceleration on qualified NVIDIA systems. VIPP records the implementation that ran, and a GPU request that cannot be honored falls back visibly to CPU.
The current public GPU route uses native 64-bit Windows, CPython 3.12, CUDA 13 and an NVIDIA GPU with compute capability 7.5 or newer. Performance depends on the operation, data and hardware. See the GPU Guide for installation, supported operation families, qualification and benchmarking.
Reproducibility And Scientific Traceability
VIPP keeps workflow structure, parameters and intermediate decisions visible during interactive design. Saved and batch-run workflows can retain source identity, semantic axes, physical calibration, selected outputs and the actual CPU or GPU implementation used.
This record supports reproducibility, but it does not establish biological validity automatically. Users remain responsible for checking assumptions, parameter choices and results on suitable controls and representative data. Read the scientific integrity boundaries and scientific behavior requirements.
Documentation
The VIPP manual is the single home for user instructions. Select a version in the manual to match your installation.
- Quick Start — installers, manual setup and the first workflow
- User Guide — graph authoring, inspection, batch processing and export
- Example workflows — bundled starting points by analysis task
- Image import and export — formats, metadata and collection inputs
- GPU Guide — acceleration, qualification and benchmarking
- Measurement workflows — quantitative analysis patterns
- Architecture — execution and scientific-integrity contracts
- Troubleshooting — common problems and support
Development And Support
Implementation context stays with the code: contributing, architecture, planning and roadmap, repository documentation, and changelog. See documentation ownership before editing a guide.
python -m venv .venv
.venv\Scripts\Activate.ps1
python -m pip install -e ".[dev]"
python -m npe2 validate src/napari_vipp/napari.yaml
python -m ruff check .
python -m pytest
Read CONTRIBUTING.md before opening a pull request. Ask usage questions in GitHub Discussions, use SUPPORT.md for help, report vulnerabilities privately through SECURITY.md, and follow the Code of Conduct.
Citation And License
If VIPP contributes to your work, acknowledge napari-vipp and link to this
repository. Citation metadata is available in CITATION.cff. A
DOI or manuscript citation will be added when available.
napari-vipp is distributed under the BSD 3-Clause License. See LICENSE for the full terms.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file napari_vipp-0.15.0a5.tar.gz.
File metadata
- Download URL: napari_vipp-0.15.0a5.tar.gz
- Upload date:
- Size: 8.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b5ac1cf0a02f1f58a2eca96b44d5a9203f637c424a4b5dc24699a9baf4e606ad
|
|
| MD5 |
98254a952e9bd6723b01f1447c6cdf3c
|
|
| BLAKE2b-256 |
4d7250f84241846d445dc29dc29e0b6a942d0fbf79e0264d997d72a691f56b60
|
File details
Details for the file napari_vipp-0.15.0a5-py3-none-any.whl.
File metadata
- Download URL: napari_vipp-0.15.0a5-py3-none-any.whl
- Upload date:
- Size: 2.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5728413ecdc212fac1aa9d64bc3a6582def39f2785065571ed6d098888ed681d
|
|
| MD5 |
3e151dd24607f2a96308eeb4ff73acc9
|
|
| BLAKE2b-256 |
37e5bc807a360eabeb6e46c3427f9c0776e4e750024ef7f49f650e5e7fdc4a64
|