Skip to main content

napari widgets to (batch) process images from start to finish.

Project description

napari-ndev

License BSD-3 PyPI Python package index download statistics Python Version tests codecov napari hub Static Badge DOI

logo

A collection of widgets intended to serve any person seeking to process microscopy images from start to finish, with no coding necessary. napari-ndev was designed to address the gap between the napari viewer and batch python scripting.

  • Accepts diverse image formats, dimensionality, file size, and maintains key metadata.
  • Allows advanced, arbitrary image processing workflows to be used by novices.
  • User-friendly sparse annotation and batch training of machine learning classifiers.
  • Flexible label measurements, parsing of metadata, and summarization for easily readable datasets.
  • Designed for ease of use, modification, and reproducibility.

Check out the Docs to learn more!

See the poster presented at BINA 2024 for an overview of the plugins in action

Try out the Virtual I2K 2024 Workshop for an interactive tutorial

Installation

napari-ndev is a pure Python package, and can be installed with pip:

pip install napari-ndev

If napari is currently not installed in your environment, you will also need to include a QtPy backend:

pip install napari-ndev[qtpy-backend]

The easiest way to get started with napari-ndev is to install all the optional dependencies (see note below) with:

pip install napari-ndev[all]

Optional Libraries

napari-ndev is most useful when interacting with some other napari plugins (e.g. napari-assistant) and can read additional filetypes. A few extra BSD3 compatible napari-plugins may be installed with pip:

pip install napari-ndev[extras]

napari-ndev can optionally use GPL-3 licensed libraries to enhance its functionality, but are not required. If you choose to install and use these optional dependencies, you must comply with the GPL-3 license terms. The main functional improvement is from some bioio libraries to support extra image formats, including czi and lif files. These libraries can be installed with pip:

pip install napari-ndev[gpl-extras]

In addition, you may need to install specific bioio readers to support your specific image, such as bioio-czi and bioio-lif (included in [gpl-extras]) or bioio-bioformats.

Development Libraries

For development use the [dev] optional libraries to verify your changes, which includes the [docs] and [testing] optional groups. However, the Github-CI will test pull requests with [testing] only.


The wide breadth of this plugin's scope is only made possible by the amazing libraries and plugins from the python and napari community, especially Robert Haase.

This napari plugin was generated with Cookiecutter using napari's cookiecutter-napari-plugin template.

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "napari-ndev" is free and open source software.

Some optional libraries can be installed to add functionality to napari-ndev, including some that may be more restrictive than this package's BSD-3-Clause.

Issues

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

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_ndev-0.11.8.tar.gz (7.3 MB view details)

Uploaded Source

Built Distribution

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

napari_ndev-0.11.8-py3-none-any.whl (6.9 MB view details)

Uploaded Python 3

File details

Details for the file napari_ndev-0.11.8.tar.gz.

File metadata

  • Download URL: napari_ndev-0.11.8.tar.gz
  • Upload date:
  • Size: 7.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for napari_ndev-0.11.8.tar.gz
Algorithm Hash digest
SHA256 cb063f478be339dfd3b6673140328374fa33a48aac51f6010463f3ffec3146fb
MD5 e38b6722556c740cbf95e0d3b3ded8e3
BLAKE2b-256 3bb4f76a6b3c7fe9fdbe369b75005810f9d00b4d9d8b86077e44dbff96fe2fff

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_ndev-0.11.8.tar.gz:

Publisher: make_release.yml on ndev-kit/napari-ndev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file napari_ndev-0.11.8-py3-none-any.whl.

File metadata

  • Download URL: napari_ndev-0.11.8-py3-none-any.whl
  • Upload date:
  • Size: 6.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for napari_ndev-0.11.8-py3-none-any.whl
Algorithm Hash digest
SHA256 aec85596c329c7ae3e56897d3b12bfee3a663d68b05d19572bad633a5ee0d508
MD5 110113cd0d21f7f976b87e66f36a8c4d
BLAKE2b-256 37decbdad127b121618c1148ff969cf7576e0be082e445abb2edab4deeab0d49

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_ndev-0.11.8-py3-none-any.whl:

Publisher: make_release.yml on ndev-kit/napari-ndev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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