\n\nVolume Explorer (Vol-E) is a browser based volume viewer built with React and WebGL (Three.js). This package wraps the [vole-core](https://github.com/allen-cell-animated/vole-core) library.\n\nFor the latest stable release, please visit [https://vole.allencell.org](https://vole.allencell.org)\n\nVolume data is provided to the core 3d viewer via one of the following file formats:\n\n- a url to a OME-ZARR image\n- a url to a OME-TIFF file\n- a json file containing dimensions and other metadata, and texture atlases (png files containing volume slices tiled across the 2d image). These texture atlases must be prepared in advance before loading into this viewer.\n\nThe volume shader itself is a heavily modified version of one that has distant origins in [Bisque](http://bioimage.ucsb.edu/bisque).\n\n## to use\n\n- `https://vole.allencell.org/?url=path/to/ZARR`\n- for more url parameters, see [`URL_SPEC.md`](documentation/URL_SPEC.md)\n\nor as React component:\n\n- `npm install @aics/vole-app`\n- import the app as `import { ImageViewerApp } from \"@aics/vole-app\"`\n- send in props as is shown in [`public/index.jsx`](public/index.tsx)\n\n```jsx\n\n```\n\n### Running with Docker\n\nClone the repository and run the following commands in the root of the project:\n\n```cmd\ndocker build -t vole-app-image .\ndocker run --rm -p 9020:80 --name vole-app vole-app-image\n```\n\nThis will create a new docker image called `vole-app` and run it on port 9020. You can access the viewer by navigating to [http://localhost:9020](http://localhost:9020) in your browser.\n\nTo rebuild changes, run the above commands again. (The `--rm` flag will automatically delete the existing container when it is stopped.)\n","readmeFilename":"README.md"}
![\"npm](\"https://img.shields.io/npm/v/%40aics%2Fvole-app\")
\n