From 08d33a369364fe00070f21a34b21b5d03e627b81 Mon Sep 17 00:00:00 2001 From: Trevor Manz Date: Fri, 19 Jul 2024 16:37:42 -0400 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e1cbbc1..587353a 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,14 @@ view multiscale zarr images online and in notebooks

- app . - getting started + standalone app . + python api . + open in colab

-[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/hms-dbmi/vizarr/blob/main/python/notebooks/mandelbrot.ipynb) - -
- Multiscale OME-Zarr in Jupyter Notebook with Vizarr -
+## About **Vizarr** is a minimal, purely client-side program for viewing zarr-based images. @@ -29,16 +26,11 @@ - 📦 Supports any `zarr-python` [store](https://zarr.readthedocs.io/en/stable/api/storage.html) as a backend. -### Data types - -**Vizarr** supports viewing 2D slices of n-Dimensional Zarr arrays, allowing -users to choose a single channel or blended composites of multiple channels -during analysis. It has special support for the developing OME-NGFF format for -multiscale and multimodal images. Currently, Viv supports `int8`, `int16`, -`int32`, `uint8`, `uint16`, `uint32`, `float32`, `float64` arrays, but -contributions are welcome to support more np.dtypes! +

+ Multiscale OME-Zarr in Jupyter Notebook with Vizarr +

-### Getting started +## Getting started Copy and paste a URL to a Zarr store as the `?source` query parameter in the **[web app](https://hms-dbmi.github.io/vizarr/)**. For example, to view the @@ -66,13 +58,22 @@ viewer.add_image(store) viewer ``` -### Limitations +## Data types + +**Vizarr** supports viewing 2D slices of n-Dimensional Zarr arrays, allowing +users to choose a single channel or blended composites of multiple channels +during analysis. It has special support for the developing OME-NGFF format for +multiscale and multimodal images. Currently, Viv supports `int8`, `int16`, +`int32`, `uint8`, `uint16`, `uint32`, `float32`, `float64` arrays, but +contributions are welcome to support more np.dtypes! + +## Limitations `vizarr` was built to support the registration use case above where multiple, pyramidal OME-Zarr images are viewed within a Jupyter Notebook. Support for other Zarr arrays is supported but not as well tested. More information regarding the viewing of generic Zarr arrays can be found in the example notebooks. -### Citation +## Citation If you are using Vizarr in your research, please cite our paper: