Skip to main content

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:

  1. Open Napari
  2. Go to Plugins > Install/Uninstall Plugins
  3. Search for "napari-reco-plugin"
  4. 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

  1. Copy a .bat file from launchers/

  2. Edit:

    • <path_to_conda> → your Anaconda/Miniconda path
    • <your_napari_env> → your environment name
  3. Double-click to launch

Desktop shortcut (optional)

  • Right-click .batSend 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 MIT 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

napari_reco_plugin-0.1.1.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_reco_plugin-0.1.1-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

Details for the file napari_reco_plugin-0.1.1.tar.gz.

File metadata

  • Download URL: napari_reco_plugin-0.1.1.tar.gz
  • Upload date:
  • Size: 31.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for napari_reco_plugin-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1b3c88e4a71f4ccd127ac5a19415c75ef9c0602378f2c63ce22b1986bee56d61
MD5 9a44eac4295ed67cd81b5c09e4c37761
BLAKE2b-256 41b4ddc456203e78f4ef90fd8a2ce6d951d8c3d0c837efffc8eb22db75ca0930

See more details on using hashes here.

File details

Details for the file napari_reco_plugin-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_reco_plugin-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f1d5d3a7e3ebcd55f1a7da387933aa1443cedc4fe0fb64158093d94320e29bf7
MD5 cbb1f3ec47099acf7d3d6cc584b8efff
BLAKE2b-256 10fe253a9045be8fea5de0354fad48f2f6d3bc84ee123bdbd22b4ad7d73382b9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page