@aics/vole-app 2.11.0

package/LICENSE

@@ -0,0 +1,33 @@
+Allen Institute Software License – This software license is the 2-clause BSD 
+license plus clause a third clause that prohibits redistribution and use for 
+commercial purposes without further permission. 
+
+Copyright © 2020. Allen Institute.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this 
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, 
+this list of conditions and the following disclaimer in the documentation 
+and/or other materials provided with the distribution.
+
+3. Redistributions and use for commercial purposes are not permitted without 
+the Allen Institute’s written permission. For purposes of this license, 
+commercial purposes are the incorporation of the Allen Institute's software 
+into anything for which you will charge fees or other compensation or use of 
+the software to perform a commercial service for a third party. Contact 
+terms@alleninstitute.org for commercial licensing opportunities.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/LICENSE.txt

@@ -0,0 +1,26 @@
+Allen Institute Software License – This software license is the 2-clause BSD license 
+plus clause a third clause that prohibits redistribution for commercial purposes without further permission.
+
+Copyright © 2017. Allen Institute. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the 
+following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the 
+following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Redistributions for commercial purposes are not permitted without the Allen Institute’s written permission.
+For purposes of this license, commercial purposes is the incorporation of the Allen Institute's software into
+anything for which you will charge fees or other compensation. Contact terms@alleninstitute.org for commercial
+licensing opportunities.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,45 @@
+# Vol-E App
+
+Volume 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.
+
+For the latest stable release, please visit [https://vole.allencell.org](https://vole.allencell.org)
+
+Volume data is provided to the core 3d viewer via one of the following file formats:
+
+- a url to a OME-ZARR image
+- a url to a OME-TIFF file
+- 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.
+
+The volume shader itself is a heavily modified version of one that has distant origins in [Bisque](http://bioimage.ucsb.edu/bisque).
+
+## to use
+
+- `https://vole.allencell.org/?url=path/to/ZARR`
+- for more url parameters, see [`URL_SPEC.md`](documentation\URL_SPEC.md)
+
+or as React component:
+
+- `npm install @aics/vole-app`
+- import the app as `import { ImageViewerApp } from "@aics/vole-app"`
+- send in props as is shown in [`public/index.jsx`](public/index.tsx)
+
+```jsx
+<ImageViewerApp
+  baseUrl="http://dev-aics-dtp-001.corp.alleninstitute.org/cellviewer-1-4-0/Cell-Viewer_Thumbnails/"
+  cellPath="AICS-17/AICS-17_4187_23618_atlas.json"
+  // ... (also see src/aics-image-viewer/components/App/types.ts for full props specification) ...
+/>
+```
+
+### Running with Docker
+
+Clone the repository and run the following commands in the root of the project:
+
+```cmd
+docker build -t vole-app-image .
+docker run --rm -p 9020:80 --name vole-app vole-app-image
+```
+
+This 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.
+
+To rebuild changes, run the above commands again. (The `--rm` flag will automatically delete the existing container when it is stopped.)