Skip to main content

A Napari plugin for tomographic reconstruction using the ASTRA Toolbox, with optional Paganin phase retrieval filter for phase-contrast data.

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 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

napari_reco_plugin-0.1.4.tar.gz (31.7 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.4-py3-none-any.whl (38.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: napari_reco_plugin-0.1.4.tar.gz
  • Upload date:
  • Size: 31.7 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.4.tar.gz
Algorithm Hash digest
SHA256 e01247c0e1dcf3457a903e19d3eb7b8a5836f0b65729599c731a4f13ef70ca69
MD5 d78b6b4bfad93995af472c60f6c2259e
BLAKE2b-256 bb016d3fbd355ea2518f9d613275b1b48e2da747329e5853e3872186f59f9fa6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for napari_reco_plugin-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d16e55f5bed3cc701812b481966b0361f6b3efa3929d92cc943119fbd5afa00e
MD5 794ac46b049c99ffec5f0d46c15d33c5
BLAKE2b-256 bc6eb7aa3f34213e3811cc22c06a7c5b134bb4da5c68de0100015c7ca5543351

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