npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ucsc-xena-viv

v0.12.8-3

Published

High bit depth, high resolution, many channels, low overhead

Downloads

5

Readme

Viv npm version package documenation

A WebGL-powered toolkit for interactive visualization of high-resolution, multiplexed bioimaging datasets.

About

Viv is a JavaScript library for rendering OME-TIFF and OME-NGFF (Zarr) directly in the browser. The rendering components of Viv are packaged as deck.gl layers, making it easy to compose with existing layers to create rich interactive visualizations.

More details and related work can be found in our preprint. Please cite this preprint in your research:

Trevor Manz, Ilan Gold, Nathan Heath Patterson, Chuck McCallum, Mark S Keller, Bruce W Herr II, Katy Börner, Jeffrey M Spraggins, Nils Gehlenborg, "Viv: Multiscale Visualization of High-resolution Multiplexed Bioimaging Data on the Web." OSF Preprints (2020), doi:10.31219/osf.io/wd2gu

💻 Related Software

| Screenshot | Description | :-------------------------:|:-------------------------: | Avivator A lightweight viewer for local and remote datasets. The source code is include in this repository under avivator/. See our 🎥 video tutorial to learn more. | Vizarr A minimal, purely client-side program for viewing OME-NGFF and other Zarr-based images. Vizarr supports a Python backend using the imjoy-rpc, allowing it to not only function as a standalone application but also directly embed in Jupyter or Google Colab Notebooks.

💥 In Action

💾 Supported Data Formats

Viv's data loaders support OME-NGFF (Zarr), OME-TIFF, and Indexed OME-TIFF*. We recommend converting proprietrary file formats to open standard formats via the bioformats2raw + raw2ometiff pipeline. Non-pyramidal datasets are also supported provided the individual texture can be uploaded to the GPU (< 4096 x 4096 in pixel size).

Please see the tutorial for more information.

*We describe Indexed OME-TIFF in our paper as an optional enhancement to provide efficient random chunk access for OME-TIFF. Our approach substantially improves chunk load times for OME-TIFF datasets with large Z, C, or T dimensions that otherwise may incur long latencies due to seeking. More information on generating an IFD index (JSON) can be found in our tutorial or documentation.

💽 Installation

$ npm install @hms-dbmi/viv

You will also need to install deck.gl and other peerDependencies manually. This step prevent users from installing multiple versions of deck.gl in their projects.

$ npm install deck.gl @luma.gl/core

Breaking changes may happen on the minor version update. Please see the changelog for information.

📖 Documentation

Detailed API information and example sippets can be found in our documentation.

🏗️ Development

$ git clone https://github.com/hms-dbmi/viv.git
$ cd viv && npm install
$ npm start

Please install the Prettier plug-in for your preferred editor. Badly formatted code will fail in our CI.

To run unit and integration tests locally, use npm test. Our full production test suite, including linting and formatting, is run via npm run test:prod.

To our knowledge, Viv can be developed with Node version greater than 10. You can check which current versions are tested in our CI by naviating to our Github Workflow.

🛠️ Build

  • @hms-dbmi/viv library: npm run build
  • Avivator viewer: npm run build:avivator

📄 Publish

First checkout a new branch like release/version. Update the CHANGELOG.md and bump the version via npm verion [major | minor | patch]. Commit locally and push a tag to Github. Next, run ./publish.sh to release the package on npm and publish Avivator. Finally, make a PR for release/version and squash + merge into master.

🌎 Browser Support

Viv supports both WebGL1 and WebGL2 contexts, to provides coverage across Safari, Firefox, Chrome, and Edge. Please file an issue if you find a browser in which Viv does not work.