napari-bruce 0.0.5

A napari plugin for drawing PALM RoboSoftware elements using StarDist segmentation

🦇 Bruce

A napari plugin for drawing PALM RoboSoftware elements using StarDist segmentation

---

Quick start

After installation (see below), open a terminal and run:

# Launch Bruce via the command line
bruce

# List all available options 
bruce -h

---

Features

• Load 2-channel images and metadata from .zvi files produced by PALM RoboSoftware 4.5
• 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 .txt file compatible with PALM RoboSoftware 4.5

---

System requirements

• Conda / Mamba (recommended)
  • Install Miniforge from: https://github.com/conda-forge/miniforge
• Java (OpenJDK) – required for Bio-Formats .zvi → OME-TIFF conversion
• 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

---

Configuration

Bruce stores its configuration in a user-specific JSON file.

Useful commands:

# Show config file path
bruce --show-config-path

# Open config in default editor
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.

Useful 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 (replace <MODEL_DIR> with the model directory)
bruce --add-model <MODEL_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.

To use them:

1. Clone or download the repository from GitHub
2. Launch Bruce
3. Load the example files via the GUI