Metadata-Version: 2.5
Name: napari-openreadout
Version: 0.1.0
Summary: napari reader plugin that opens microscopy files lazily with OpenReadout
Project-URL: Homepage, https://github.com/openreadout/openreadout
Project-URL: Repository, https://github.com/openreadout/openreadout
Project-URL: Documentation, https://openreadout.github.io/openreadout/guides/napari.html
Author-email: The OpenReadout Authors <openreadout@gmail.com>
License-Expression: MIT OR Apache-2.0
License-File: LICENSE-APACHE
License-File: LICENSE-MIT
Keywords: czi,lif,microscopy,napari,nd2,ome-zarr,svs,whole-slide
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: napari
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: numpy>=1.22
Requires-Dist: openreadout[dask]<0.2,>=0.1.0
Provides-Extra: test
Requires-Dist: npe2>=0.7; extra == 'test'
Requires-Dist: pytest>=7; extra == 'test'
Description-Content-Type: text/markdown

# napari-openreadout

A [napari](https://napari.org) reader plugin that opens raw microscopy and electron-microscopy files with [OpenReadout](https://github.com/openreadout/openreadout). The formats it reads are listed at <https://openreadout.github.io/openreadout/formats.html>.

```bash
pip install napari napari-openreadout
napari slide.svs
```

- **Lazy**: layers are dask arrays; a plane (or, for large tiled planes, the tiles under the
  view) is decoded only when displayed.
- **Multiscale**: pyramidal files (CZI pyramids, SVS/NDPI/QPTIFF, VSI, Imaris, OME-TIFF with
  SubIFDs, OME-Zarr multiscales) open as multiscale layers.
- **Channels** become separate layers named after the file's channels, coloured by their
  recorded colours; **scale** is the physical pixel size in µm (and the time step in s).
- Every image of the file (CZI scene, ND2 position, LIF series) is its own layer.

Without napari, `napari_openreadout.read(path)` returns the same `(data, kwargs, "image")` tuples.

Guide: <https://openreadout.github.io/openreadout/guides/napari.html>. Licensed MIT OR Apache-2.0.
