Skip to main content

Read, write, and manage images in napari

Project description

ndevio

License BSD-3 PyPI Python Version tests codecov napari hub npe2 Copier

Read, write, and manage images in napari


This napari plugin was generated with copier using the napari-plugin-template.

Installation

You can install ndevio via pip:

pip install ndevio

If napari is not already installed, you can install ndevio with napari and Qt via:

pip install "ndevio[all]"

To install the latest development version:

pip install git+https://github.com/ndev-kit/ndevio.git

Additional Image Format Support

ndevio uses bioio for flexible image reading. Basic formats (TIFF, OME-TIFF, OME-Zarr, PNG, etc.) are supported out of the box via:

  • bioio-ome-tiff - OME-TIFF files
  • bioio-ome-zarr - OME-Zarr files
  • bioio-tifffile - General TIFF files
  • bioio-imageio - PNG, JPEG, and other common formats

If your image format is not supported by the default readers, then you will get a warning and (by default in napari) a widget to install the suggested reader. If you know of your additional proprietary formats, install the appropriate bioio reader.

# CZI files (GPL-3 licensed)
pip install bioio-czi

# LIF files (GPL-3 licensed)
pip install bioio-lif

# Bio-Formats for many formats (behavior not guaranteed)
pip install bioio-bioformats

See the bioio documentation for the full list of available readers.

Pixi Usage

You can use Pixi for reproducible development environments:

git clone https://github.com/ndev-kit/ndevio.git
cd ndevio
pixi install -e dev
pixi run -e dev test

Or activate the environment and run commands directly:

pixi shell -e dev
pytest -v

Development

For development, clone the repository and install with the dev dependency group:

git clone https://github.com/ndev-kit/ndevio.git
cd ndevio
pip install -e . --group dev

This includes pytest, pytest-cov, pytest-qt, tox-uv, napari, and pyqt6.

Run tests with:

pytest -v --cov=ndevio --cov-report=html

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, "ndevio" is free and open source software

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

ndevio-0.8.0.tar.gz (4.3 MB view details)

Uploaded Source

Built Distribution

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

ndevio-0.8.0-py3-none-any.whl (188.7 kB view details)

Uploaded Python 3

File details

Details for the file ndevio-0.8.0.tar.gz.

File metadata

  • Download URL: ndevio-0.8.0.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ndevio-0.8.0.tar.gz
Algorithm Hash digest
SHA256 0ad7fa75d6bd2e58ad45178906a40a58b0b205cc2f06b2bbdb20400bed39878b
MD5 d592921650175b38cc949d34a1ae84b1
BLAKE2b-256 472a5f26a3213cf10a0cb63b52f08a75c8004f35df6036c76810ab3f39677a58

See more details on using hashes here.

Provenance

The following attestation bundles were made for ndevio-0.8.0.tar.gz:

Publisher: test_and_deploy.yml on ndev-kit/ndevio

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

File details

Details for the file ndevio-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: ndevio-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 188.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ndevio-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21e19a07eec269a08a921c68e95fa1209bcba29a69b59194dfa937faca0dd742
MD5 5b07fc080d2261a479b64889139a3f62
BLAKE2b-256 d8ba244ed31a0f590c1d3f3eb5f2dd6063c2a155b7d2b85527945a4db8f29df1

See more details on using hashes here.

Provenance

The following attestation bundles were made for ndevio-0.8.0-py3-none-any.whl:

Publisher: test_and_deploy.yml on ndev-kit/ndevio

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