Skip to main content

Napari plugin for GPU-accelerated tomographic reconstruction with Paganin phase retrieval

Project description

Reconstruction Napari Plugin

This project is a Napari plugin for GPU-accelerated tomographic reconstruction, including Paganin phase retrieval.

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.git
cd Reconstruction

4. Install the plugin

pip install -e .

Requirements

Core

  • Python ≥ 3.9
  • Napari

Optional (for GPU acceleration)

  • CUDA Toolkit
  • CuPy
  • ASTRA Toolbox

⚠️ 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.0.tar.gz (31.1 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.0-py3-none-any.whl (37.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: napari_reco_plugin-0.1.0.tar.gz
  • Upload date:
  • Size: 31.1 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.0.tar.gz
Algorithm Hash digest
SHA256 388c13bb62e4a82958ddcf08079b05a32c1e36af1ca41f0582f8e9b5bd415f06
MD5 166dbd3749058d993c75aa062dc784f1
BLAKE2b-256 66aff51f7ccb206d2c43989e3a64ea6612864efc910ff48448cdadbb54b4eb65

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for napari_reco_plugin-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 117c7bf4db859a09800e3205d936395149320e5746260c5c20fc32fea14f6d65
MD5 2acb943d9b68af2e66f6cb9b7c52d84a
BLAKE2b-256 50bce8d4e7e29244862db71b1df4be6f588021cc3385bc5e22621d6658d4a647

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