Skip to main content

Nanoscopy Python library (NanoPyx, the successor to NanoJ) - focused on light microscopy and super-resolution imaging

Project description

Logo

Under Development, currently in beta stage

PyPI Python Version Downloads Docs License Tests Contributors GitHub stars GitHub forks DOI

Nanoscopy Python library (NanoPyx, the successor to NanoJ) - focused on light microscopy and super-resolution imaging


What is the NanoPyx 🔬 Library?

NanoPyx is a library specialized in the analysis of light microscopy and super-resolution data. It is a successor to NanoJ, which is a Java library for the analysis of super-resolution microscopy data.

NanoPyx focuses on performance, by heavily exploiting cython aided multiprocessing and simplicity. It implements methods for the bioimage analysis field, with a special emphasis on those developed by the Henriques Laboratory. It will be distributed as a Python Library and also as Codeless Jupyter Notebooks, that can be run locally or on Google Colab, and as a napari plugin.

Currently it implements the following approaches:

  • A reimplementation of the NanoJ image registration, SRRF and Super Resolution metrics
  • More to come soon™

if you found this work useful, please cite: DOI

Short Video Tutorials

What is NanoPyx? How to use NanoPyx in Google Colab?

Codeless jupyter notebooks available:

Category Method Last test Notebook Colab Link
Registration Channel Registration ✅ by BMS (20/04/23) Jupyter Notebook Open in Colab
Registration Drift Correction ✅ by BMS (20/04/23) Jupyter Notebook Open in Colab
Quality Control Image fidelity and resolution metrics ✅ by BMS (20/04/23) Jupyter Notebook Open in Colab
Super-resolution SRRF ✅ by BMS (20/04/23) Jupyter Notebook Open in Colab
Tutorial Notebook with Example Dataset ✅ by BMS (20/04/23) Jupyter Notebook Open In Colab

napari plugin

NanoPyx is also available as a napari plugin, which can be installed via pip:

pip install napari-nanopyx

Installation

You can install NanoPyx via pip:

pip install nanopyx

or if you want to install with all optional dependencies

pip install 'nanopyx[all]'

To install latest development version :

pip install git+https://github.com/HenriquesLab/NanoPyx.git

Notes for Mac users

If you wish to compile the NanoPyx library from source, you will need to install the following dependencies:

  • Homebrew from https://brew.sh/
  • gcc, llvm and libomp from Homebrew through the command:
brew install gcc llvm libomp

Run in jupyterlab within a docker container

docker run --name nanopyx1 -p 8888:8888 henriqueslab/nanopyx:latest

Contributing

Contributions are very welcome. Please read our Contribution Guidelines to know how to proceed.

License

Distributed under the terms of the GNU GPL v2.0 license, "NanoPyx" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Development at a glance

Repography logo / Structure

Structure

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

nanopyx-0.2.0.tar.gz (7.6 MB view hashes)

Uploaded Source

Built Distributions

nanopyx-0.2.0-cp311-cp311-win_amd64.whl (11.4 MB view hashes)

Uploaded CPython 3.11 Windows x86-64

nanopyx-0.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (12.9 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

nanopyx-0.2.0-cp311-cp311-macosx_13_0_arm64.whl (11.6 MB view hashes)

Uploaded CPython 3.11 macOS 13.0+ ARM64

nanopyx-0.2.0-cp311-cp311-macosx_10_9_x86_64.whl (12.1 MB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

nanopyx-0.2.0-cp310-cp310-win_amd64.whl (11.3 MB view hashes)

Uploaded CPython 3.10 Windows x86-64

nanopyx-0.2.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (12.9 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

nanopyx-0.2.0-cp310-cp310-macosx_11_0_arm64.whl (11.7 MB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

nanopyx-0.2.0-cp310-cp310-macosx_10_9_x86_64.whl (12.1 MB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

nanopyx-0.2.0-cp39-cp39-win_amd64.whl (11.4 MB view hashes)

Uploaded CPython 3.9 Windows x86-64

nanopyx-0.2.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (12.9 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

nanopyx-0.2.0-cp39-cp39-macosx_13_0_arm64.whl (11.6 MB view hashes)

Uploaded CPython 3.9 macOS 13.0+ ARM64

nanopyx-0.2.0-cp39-cp39-macosx_10_9_x86_64.whl (12.1 MB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

Supported by

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