Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tlambert03 authored Jun 7, 2024
1 parent ff279d8 commit 280ade6
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,42 @@
[![CI](https://github.com/tlambert03/ndv/actions/workflows/ci.yml/badge.svg)](https://github.com/tlambert03/ndv/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/tlambert03/ndv/branch/main/graph/badge.svg)](https://codecov.io/gh/tlambert03/ndv)

simple ndviewer
Simple python nd array viewer:

```python
from qtpy import QtWidgets
from ndv import NDViewer
from skimage import data

qapp = QtWidgets.QApplication([])
v = NDViewer(data.cells3d())
v.show()
qapp.exec()
```

![Montage](https://github.com/tlambert03/ndv/assets/1609449/712861f7-ddcb-4ecd-9a4c-ba5f0cc1ee2c)

## `NDViewer`

Simple, fast-loading, asynchronous, n-dimensional viewer for Qt. Minimal dependencies.

- supports arbitrary number of dimensions, with 2D/3D view canvas, and sliders for all non-visible dims
- sliders support integer as well as slice (range)-based slicing
- colormaps provided by [cmap](https://github.com/tlambert03/cmap)
- supports [vispy](https://github.com/vispy/vispy) and [pygfx](https://github.com/pygfx/pygfx) backends
- supports any numpy-like duck arrays, with special support for features in:
- `xarray.DataArray`
- `dask.array.Array`
- `tensorstore.TensorStore`
- `zarr`
- `dask`

## Installation

The only required dependencies are `numpy` and `superqt[cmap,iconify]`.
You will also need a Qt backend (PyQt or PySide) and one of either
[vispy](https://github.com/vispy/vispy) or [pygfx](https://github.com/pygfx/pygfx):

```python
pip install ndv[pyqt,vispy]
```

0 comments on commit 280ade6

Please sign in to comment.