Skip to main content

napari-metadata

License BSD-3 PyPI Python Version tests codecov napari hub

napari-metadata is a napari plugin that visually exposes the functionality of napari's handling of layer metadata by directly connecting with the public API of napari layers.

[!NOTE] This plugin is in active development. You should not depend on any API, as it is likely to change. Instead, understand that this plugin intends to serve as a GUI to manage already available public API of napari layers. If you find a feature of this plugin useful, but it is not available in napari's core API, please consider opening an issue here or in the napari repository.

Installation

You can install napari-metadata from PyPI:

pip install napari-metadata

or from conda-forge:

conda install napari-metadata

Usage

This plugin adds a dock widget to napari that allows you to view and edit metadata for each layer in your napari viewer. The widget is intended to be used in the typical vertical widget layout and additionally is designed to work great in a horizontal layout.

horizontal layout of metadata widget

File Metadata

The File Metadata section displays metadata related to the source of the layer, such as name, shape, dtype, and file size. All information except layer name is read-only.

Axes Metadata

The Axes Metadata section allows you to view and edit metadata related to the axes of the layer, such as axis labels, transforms, scales, and units. You can modify these properties directly in the widget, and the changes will be reflected in the layer, and visa versa.

[!TIP] Layers can be linked using the napari layer context menu Link Layers. When axes metadata is changed in the widget, all linked layers will update their axes metadata accordingly.

Axes Inheritance

The Axes Inheritance widget can be used to propagate axes metadata from one layer to other layers. Select a template layer from the dropdown, and apply any axes metadata with checked boolean boxes to the currently active layer and any linked layers.

Contributing

Contributions are very welcome! Please see the CONTRIBUTING.md file for details.

License

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari_metadata-0.4.0.tar.gz (4.5 MB view details)

Uploaded Source

Built Distribution

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

napari_metadata-0.4.0-py3-none-any.whl (44.8 kB view details)

Uploaded Python 3

File details

Details for the file napari_metadata-0.4.0.tar.gz.

File metadata

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

File hashes

Hashes for napari_metadata-0.4.0.tar.gz
Algorithm Hash digest
SHA256 e5feb51142a7b648b66250b68a0d0bd669068d289b6bef361e21d39149fe675b
MD5 ec6052f9be904c4f4973a68f324051ca
BLAKE2b-256 31da9bf12d4f7ebe25e7fd281fe1d695c5e13630cb0fad04d76558ed5e423815

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_metadata-0.4.0.tar.gz:

Publisher: test_and_deploy.yml on napari/napari-metadata

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_metadata-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_metadata-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b2d7fac5b0181a6cd66c143ffb5607e97a9de82ba306d24887ebbb097f96846
MD5 fae99a7fcbdbee1a06177f5b23ec726c
BLAKE2b-256 58cbef0175f913264a3ab1edc072fea1e1e66e02edf77df97a13f223a6981c1e

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_metadata-0.4.0-py3-none-any.whl:

Publisher: test_and_deploy.yml on napari/napari-metadata

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 Sentry Error logging StatusPage Status page