Update naming (#229)

hms-dbmi · Aug 11, 2020 · 5bcec42 · 5bcec42
1 parent 92f561c
commit 5bcec42
Show file tree

Hide file tree

Showing 74 changed files with 2,031 additions and 1,234 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,3 @@
 dist/
 test_dist/
+dist_docs/
diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,7 @@
 /.pnp
 .pnp.js
 /test_dist
+/dist_docs
 
 # testing
 /coverage

diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,5 @@
 dist/
 **/*.yml
 test_dist/
+dist_docs/
+node_modules/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,13 @@
 
 ### Added
 
+- Lens view built into layers.
+- Add avivator.
+
 ### Changed
 
+- Update docs for avivator.
+
 ## 0.3.3
 
 ### Added

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 vitessce-image-viewer
+Copyright (c) 2020 viv
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,8 +1,20 @@
-### vitessce-image-viewer ("Viv") [![npm version](https://badge.fury.io/js/%40hubmap%2Fvitessce-image-viewer.svg)](https://badge.fury.io/js/%40hubmap%2Fvitessce-image-viewer)
+### Viv [![npm version](https://badge.fury.io/js/%40hms-dbmi%2Fviv.svg)](https://badge.fury.io/js/%40hms-dbmi%2Fviv)
 
-A viewer for high bit depth, high resolution, multi-channel images using DeckGL
-over the hood and WebGL under the hood. To learn more about the "theory" behind
-this, look at [this](https://github.com/hubmapconsortium/vitessce-image-viewer/blob/master/docs/IMAGE_RENDERING.md).
+A library for high bit depth, high resolution, multi-channel images using deck.gl
+with WebGL.
+
+### About
+
+Viv is a JavaScript library providing utilities for rendering primary imaging data. Viv supports WebGL-based multi-channel rendering of both pyramidal and non-pyramidal images. The rendering components of Viv are provided as Deck.gl layers, making it easy to compose images with existing layers and efficiently update rendering properties within a reactive paradigm. 
+
+### Avivator
+
+Also included in this repository is [`Avivator`](http://avivator.gehlenborglab.org), a lightweight "batteries-included" 
+WebGL viewer for remote microscopy data. Avivator is a purely client-side program that requires access to
+Bio-Formats "raw" Zarr or OME-TIFF data over HTTP. To use Avivator with your own data, please see the data preparation 
+[tutorial](tutorial/README.md). Initial load time for OME-TIFFs can be optimized by generating a special `offsets.json`
+file containing byte offsets for the associated binary data. For more information, see the 
+[documentation](http://viv.gehlenborglab.org/#ome-tiff-loading).
 
 ### Build
 
@@ -21,11 +33,11 @@ Please install the [Prettier plug-in](https://prettier.io/docs/en/editors.html)
 for your preferred editor. (Badly formatted code will fail on Travis.)
 
 For the demo, run `npm start` and you will be able to update the component and use the
-`demo/src/App.js` to visually test.
+`avivator/src/index.js` to visually test.
 
 HTTP is acceptable but potentially slower than HTTP2. Our demo uses Google Cloud Storage, which is HTTP2 by default.
 
-Due to [difficulties](https://github.com/hubmapconsortium/vitessce-image-viewer/issues/103) around compiling shaders on Travis, unit tests and layer lifecycle
+Due to [difficulties](https://github.com/hms-dbmi/viv/issues/103) around compiling shaders on Travis, unit tests and layer lifecycle
 tests are run locally as a pre-push hook. Travis runs a test build, linting, and prettier.
 
 ### Browser Support
@@ -34,4 +46,4 @@ We support both WebGL1 and WebGL2 contexts, which should give near universal cov
 
 ### Documentation
 
-Please navigate to [viv.vitessce.io/docs](http://viv.vitessce.io/docs) to see full documenation.
+Please navigate to [viv.gehlenborglab.org](http://viv.gehlenborglab.org) to see full documenation.
diff --git a/demo/.eslintrc.yml → avivator/.eslintrc.yml b/demo/.eslintrc.yml → avivator/.eslintrc.yml
diff --git a/demo/public/index.html → avivator/public/index.html b/demo/public/index.html → avivator/public/index.html
@@ -21,7 +21,7 @@
       work correctly both with client-side routing and a non-root public URL.
       Learn how to configure a non-root public URL by running `npm run build`.
     -->
-    <title>Viv Demo</title>
+    <title>AVIVATOR</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>

diff --git a/demo/public/manifest.json → avivator/public/manifest.json b/demo/public/manifest.json → avivator/public/manifest.json
diff --git a/demo/public/robots.txt → avivator/public/robots.txt b/demo/public/robots.txt → avivator/public/robots.txt