🦇 Bruce
A napari plugin for creating PALMRobo elements using StarDist segmentation
Description
Bruce is a napari plugin for automated detection of cells of interest in PALM RoboSoftware images, enabling fast laser capture microdissection on the PALM MicroBeam system.
Key features:
- Load 2-channel images and metadata from
.zvifiles produced by PALMRobo 4.9 - Perform StarDist-based cell segmentation (default or user-defined models)
- Allow manual editing of ROIs / elements in napari
- Perform ROI overlap analysis between 2 channels
- Export element list as
.txtfile compatible with PALMRobo 4.9
System requirements
- Conda / Mamba (recommended)
- Install Miniforge from: https://github.com/conda-forge/miniforge
- Java (OpenJDK) – required for Bio-Formats
.zvi → OME-TIFFconversion - GPU (optional) – for accelerated StarDist inference
Installation
Bruce requires a platform-specific Conda environment due to differences in native dependencies and GPU support. Predefined environment files are provided in the env/ directory:
| Platform | Environment file |
|-------------------------|--------------------------------------|
| Windows (native) | `env/bruce-env_windows_native.yml` |
| macOS (Apple Silicon) | `env/bruce-env_macos_arm.yml` |
| Linux | `env/bruce-env_linux.yml` |
Open a terminal and run:
# Create the conda environment (replace <ENV_FILE> with the appropriate .yml file)
mamba env create -f <ENV_FILE>
# Activate the environment
mamba activate bruce-env
# Install Bruce from PyPI
pip install napari-bruce
# Launch Bruce via the command line
bruce
# Or launch Bruce directly from napari
napari --with napari-bruce
# Show help
bruce -h
Configuration
Bruce stores its configuration in a user-specific JSON file.
Available commands:
# Show config file path
bruce --show-config-path
# Open config file in default text editor
bruce --open-config-file
# Edit config in a dedicated GUI window
bruce --edit-config
# Reset config to defaults
bruce --reset-config
GPU support & StarDist models
Bruce runs StarDist predictions on the GPU when visible to TensorFlow, and supports user-defined StarDist models.
Available commands:
# Check whether GPU(s) are visible to TensorFlow
bruce --gpu-status
# List available StarDist models
bruce --list-models
# Add a user-defined StarDist model located at <MODEL_DIR>
bruce --add-model <MODEL_DIR>
Image annotation for model training
Bruce comes with a dedicated GUI to annotate 2-channel images produced by PALMRobo 4.9.
Available commands:
# Construct an image set from 2-channel .zvi files located at <IN_DIR> and save to <OUT_DIR>/imgs.pkl
bruce --zvi-to-dict <IN_DIR> <OUT_DIR>
# Open the annotation GUI to label the image set at <IN_DIR>/imgs.pkl and save image/mask pairs to <OUT_DIR>/imgs_annotated.pkl
bruce --annotate <IN_DIR> <OUT_DIR>
Example images
Example .zvi files are provided in the example_images/ directory for testing and demonstration purposes.
They are not installed with the napari-bruce Python package.
1 maintainer
Metadata
1 maintainer
Release files for napari-bruce 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| napari_bruce-0.6.0.tar.gz | 72.8 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| napari_bruce-0.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 145.6 MB
Release files / napari_bruce-0.6.0.tar.gz
| Download URL | napari_bruce-0.6.0.tar.gz |
|---|---|
| Size | 72.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9618b9c2602c20fe3f56f8684443ac1941f893bb5c430754d219cec801f75c54
|
|
BLAKE2b-256 checksum How to use checksums |
0ff9f4337b8fb93778071fa03d2fbd0a92f22f78b387a04fdb20bac5e03d5772
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.12
|
Release files / napari_bruce-0.6.0-py3-none-any.whl
| Download URL | napari_bruce-0.6.0-py3-none-any.whl |
|---|---|
| Size | 72.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c0a972495f4674f2e4101cc14135f3a3e71090c723d87afdc29d4a43845a30ab
|
|
BLAKE2b-256 checksum How to use checksums |
5d5ef287d2cea428c9961767935941da828aab303f8a47cb3f2a4f629cf21051
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.12
|
