Napari plugin for GPU-accelerated tomographic reconstruction with Paganin phase retrieval
Project description
Reconstruction Napari Plugin
A Napari plugin for tomographic reconstruction using the ASTRA Toolbox, with optional Paganin phase retrieval filter for phase-contrast data.
Supported reconstruction algorithms: FBP, BP, SIRT, SART, CGLS — all available in CPU or GPU (CUDA) mode.
Installation
Option 1 — Install from Napari Hub (recommended)
Once published, the plugin can be installed directly from the Napari plugin manager:
- Open Napari
- Go to Plugins > Install/Uninstall Plugins
- Search for "napari-reco-plugin"
- Click Install
Alternatively, install via pip:
pip install napari-reco-plugin
Option 2 — Manual installation (development)
1. Create and activate a conda environment
conda create -n napari-env python=3.12
conda activate napari-env
2. Install main dependencies
conda install -c conda-forge napari pyqt
conda install -c astra-toolbox -c nvidia astra-toolbox
# Ensure compatibility with ASTRA
pip install numpy==1.26.4
# Install CuPy depending on your CUDA version
pip install cupy-cuda12x # or cupy-cuda11x
3. Clone the repository
git clone https://github.com/Clementcmoi/Reconstruction-napari-plugin.git
cd Reconstruction-napari-plugin
4. Install the plugin
pip install -e .
Requirements
Core
- Python ≥ 3.9
- Napari
- ASTRA Toolbox
Optional (for GPU acceleration)
- CUDA Toolkit
- CuPy
⚠️ GPU dependencies are not installed automatically. You must install them manually according to your system configuration.
Usage
Start Napari:
napari
Then open the plugin via:
Plugins > Reconstruction Plugin
Available tools:
- Reconstruction
- Multi Paganin
Launchers Templates
Template scripts for launching Napari with the correct environment are available in the launchers/ folder.
Usage
-
Copy a
.batfile fromlaunchers/ -
Edit:
<path_to_conda>→ your Anaconda/Miniconda path<your_napari_env>→ your environment name
-
Double-click to launch
Desktop shortcut (optional)
- Right-click
.bat→ Send to Desktop - (Optional) Change icon via shortcut properties
Project Structure
- Plugin source code:
src/reco_plugin/ - Plugin manifest:
src/reco_plugin/napari.yaml
License
This project is licensed under the GNU General Public License v3.0 (GPL-3.0), in compliance with the ASTRA Toolbox license.
Project details
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_reco_plugin-0.1.2.tar.gz.
File metadata
- Download URL: napari_reco_plugin-0.1.2.tar.gz
- Upload date:
- Size: 31.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
df655e632814387a379710ed9352a62b23168e4e3e9d54cc33f6510250cd0d83
|
|
| MD5 |
a2ecc062031cf4fa62836aebf389d901
|
|
| BLAKE2b-256 |
edcfbbb21109fc8baf933b6460d1995c34b18dc49250100bf2c97adb27dcd0ad
|
File details
Details for the file napari_reco_plugin-0.1.2-py3-none-any.whl.
File metadata
- Download URL: napari_reco_plugin-0.1.2-py3-none-any.whl
- Upload date:
- Size: 37.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
63284c7410f5c04d2998326aff9256d807768179ab96327180c993c602e6d1fa
|
|
| MD5 |
beec4160de87520577753f90bef34ad9
|
|
| BLAKE2b-256 |
7abf49713ca06bfa8401c0d9c2325cf6bddfb3ed912286f87059fc6801432f84
|