Local chat assistant scaffold for napari image-analysis workflows
Project description
napari-chat-assistant
Local Ollama-powered assistant for napari image-analysis workflows.
napari-chat-assistant adds a dock widget inside napari that understands the active viewer session, runs built-in image-analysis actions, and generates executable napari Python code when a request goes beyond the current toolset.
It is designed for local interactive work, repeatable workflows, and gradual automation rather than cloud chat or fully opaque “one-click AI”.
Overview
Current capabilities include:
- connect to a local Ollama server
- discover and unload local models from the plugin UI
- inspect layers and selected-layer properties
- apply built-in image tools from chat
- automate batch actions across multiple layers
- generate napari Python code when no built-in tool fits
- copy or run generated code from the assistant UI
- save, pin, and reuse prompts through a local Prompt Library
The current default model is:
qwen3.5
Why This Plugin
Most chat interfaces are detached from the actual napari session. This plugin keeps the assistant inside the viewer and grounds its responses in:
- loaded layers
- the selected layer
- shape and dtype
- labels statistics
- local tool execution
- local Python code generation
Local-first by design
The assistant runs on local open-weight models through Ollama:
- no API key required
- no internet dependency
- no cloud services
- no data leaves your workstation
This makes it suitable for research workflows where the user wants interactive help, repeatable prompts, and local control over data and models.
Current Features
Session-aware tools
The assistant currently supports built-in tools for:
- listing all layers
- inspecting the selected layer
- inspecting a specific named layer
- CLAHE contrast enhancement for grayscale 2D and 3D images
- batch CLAHE across multiple image layers
- threshold preview
- threshold apply
- batch threshold preview and apply
- mask measurement
- batch mask measurement
- mask morphology operations
Supported mask operations:
dilateerodeopenclosefill_holesremove_smallkeep_largest
Code generation workflows
When a request is not covered by a built-in tool, the assistant can return napari Python code instead of guessing.
Generated code can be:
- copied to the clipboard
- executed from the plugin after user review
This is useful when you want a reusable script, need to adjust code manually, or prefer explicit code over hidden automation.
Prompt Library
The assistant includes a persistent Prompt Library for repeatable workflows:
- built-in starter prompts
- recent prompts captured automatically
- saved prompts for reusable tasks
- pinned prompts for high-frequency workflows
Interaction:
- single click loads a prompt into the editor
- double click sends it directly
This is designed for users who want repeatable automation without committing everything to full scripting.
Requirements
- Python 3.9+
- napari
- Ollama installed locally
- a local Ollama model such as
qwen3.5
Tested during development on an NVIDIA DGX Spark workstation.
The plugin does not bundle the Ollama server or model weights.
Installation
1. Install Ollama
Install Ollama on the same machine that runs napari, then start the local server:
ollama serve
Pull a model before using the plugin:
ollama pull qwen3.5
Optional alternatives:
ollama pull qwen3-coder-next:latest
ollama pull qwen3.5:35b
ollama pull qwen2.5:7b
2. Install the plugin
Clone the repository and install it in editable mode:
git clone https://github.com/wulinteousa2-hash/napari-chat-assistant.git
cd napari-chat-assistant
pip install -e .
Usage
- Start napari.
- Open
Plugins -> Chat Assistant. - Leave
Base URLashttp://127.0.0.1:11434unless your Ollama server is elsewhere. - Choose a model from the
Modeldropdown or type a model tag manually. - Click
Test Connection. - Start chatting, or use the Prompt Library for repeatable tasks.
The assistant works best when prompts describe a concrete action.
Examples:
Layer inspection:
list all layers in the current viewerinspect the selected layer propertiesinspect layer LV-nerve and report its shape and dtype
EM contrast enhancement:
apply CLAHE to the selected EM imageapply CLAHE to the selected image with kernel_size 32, clip_limit 0.01, nbins 256apply CLAHE to all open EM images with kernel_size 64, clip_limit 0.02, nbins 512
Thresholding and masks:
preview a threshold mask for the selected image layerapply a threshold optimized for dim objects on the selected imagemeasure connected components in the current mask layer
Code generation:
write napari code to duplicate the selected layergenerate QtConsole code to print the selected layer shape
UI Overview
Model Connection
- local Ollama base URL
- model picker with discovered local models
- test connection
- use selected model
- model help with model-tag examples, memory guidance, and terminal pull instructions
- unload model
Prompt Library
- built-in prompts
- recent prompts
- saved prompts
- pinned prompts
- single click to load
- double click to send
Chat
- multi-line prompt box
- Enter to send
- Shift/Ctrl/Alt+Enter for newline
- transcript showing user messages, assistant replies, tool results, and generated code
Code Actions
Run Pending CodeCopy Pending CodeDiscard Pending Code
Current Context
- current layer summary from the active napari viewer
Action Log
- local status updates
- model connection messages
- tool execution messages
- code execution and copy actions
How It Works
The assistant is designed to operate within constrained napari workflows rather than as a general-purpose chatbot.
The current strategy is:
- collect structured napari viewer context
- send that context and the user request to a local Ollama model
- the model returns a structured JSON response that specifies either:
- a normal reply
- a built-in tool call
- generated Python code
- run the selected tool or expose the generated code through the UI
This keeps the assistant more grounded than a plain chat interface and makes common operations more reliable.
Recommended Models
Good starting choices:
qwen3.5qwen3-coder-next:latestqwen2.5:7bqwen3.5:35b
Selection guidance:
qwen3.5is the current default and a good general model for this workflow. The local install you tested is about 9.7B parameters.qwen3-coder-next:latestis a better candidate for Python and napari code generation, but it is significantly heavier.qwen2.5:7bis lighter and may fit smaller-memory systems more easily.qwen3.5:35bis a larger general model that needs substantially more memory thanqwen3.5.
Memory note:
- Larger tags require more RAM or VRAM.
- On the DGX Spark setup used during development,
qwen3-coder-next:latestmay need around 100 GB of available memory to run comfortably.
Current Limitations
- model output can still be inconsistent, especially for generated code
- not all requests map cleanly to built-in tools yet
- generated code can still fail if the model invents incorrect napari APIs
- no multi-step task planning yet (complex workflows may require several prompts)
- no image attachment or multimodal input pipeline yet
- performance optimization for very large 2D/3D datasets is still in progress
Most reliable current workflow:
- use built-in tools for common layer inspection and mask/image actions
- use the Prompt Library for repeated tasks
- use generated code when you want explicit review and control
Troubleshooting
Ollama not running
If Test Connection fails after restarting your computer, Ollama is usually not running yet.
Start it in a terminal:
ollama serve
Then return to the plugin and click Test Connection again.
Pulling a model
Model downloads are intentionally handled outside the plugin.
To try a different model:
- browse tags at
https://ollama.com/search - type the tag into the plugin
Modelfield if needed - pull it in a terminal, for example:
ollama pull qwen3.5
Then use Test Connection to refresh the plugin state.
Logs and crash logs
The plugin writes two local log files:
~/.napari-chat-assistant/assistant.log~/.napari-chat-assistant/crash.log
Use these together with the terminal traceback when diagnosing crashes or unclear UI failures.
Development
Editable install:
pip install -e .
Build a release artifact:
python -m build
License
MIT.
Project details
Release history Release notifications | RSS feed
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_chat_assistant-1.1.1.tar.gz.
File metadata
- Download URL: napari_chat_assistant-1.1.1.tar.gz
- Upload date:
- Size: 29.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1af7c5e71033320c8bbd25ae4a389684248c3c135bdd3a7c659145634d89b57c
|
|
| MD5 |
de4d4f41bb5c1922ea109efd00c6d7f9
|
|
| BLAKE2b-256 |
dc1c8def1eb3c9d2153fea07732b445891c9d8fa37e8cf608c18e7d87e125e3e
|
File details
Details for the file napari_chat_assistant-1.1.1-py3-none-any.whl.
File metadata
- Download URL: napari_chat_assistant-1.1.1-py3-none-any.whl
- Upload date:
- Size: 28.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
170d15c224491805fa69bb8dbbd768beaaef5bb8770e6b70a0925d0112efcd74
|
|
| MD5 |
6417e72828238372cc79230e00718046
|
|
| BLAKE2b-256 |
dbbecb362b8091a88ce262981ab9f556df89ee4b93160a885e83eff9aac87a16
|