Demo READMEs update (#383)

* updated demo readme gallery with images and links

* added, cleaned, and updated demo readmes.

* added notebooks mini readme

README.md

@@ -28,7 +28,7 @@ Due to native dependency distribution complexity, pre-packaged builds of the `no
 See [DEVELOP.md](https://github.com/rapidsai/node/blob/main/DEVELOP.md) for details on setting up a local dev environment and building the code.
 
 We want your input! Join us in the [#node-rapids channel](https://rapids-goai.slack.com/archives/C0237JMVBRS) in the [RAPIDS-GoAI Slack workspace](https://rapids-goai.slack.com).
-  
+
 ## Tracking Progress
 
 You can review [BINDINGS.md](https://github.com/rapidsai/node/blob/main/BINDINGS.md) to see which bindings have been completed for each of the RAPIDS libraries.
@@ -37,10 +37,8 @@ You can review [BINDINGS.md](https://github.com/rapidsai/node/blob/main/BINDINGS
 
 Check out our [demos](https://github.com/rapidsai/node/tree/main/modules/demo) to see various visualization and compute capabilities:
 
-* [OpenGL lessons in luma.gl](https://github.com/rapidsai/node/tree/main/modules/demo/luma/)
 * [Library of deck.gl demos in OpenGL](https://github.com/rapidsai/node/tree/main/modules/demo/deck/)
-* [Rendering text via Xterm.js's WebGL addon](https://github.com/rapidsai/node/tree/main/modules/demo/xterm/)
-* [TensorFlow.js Examples](https://github.com/rapidsai/node/tree/main/modules/demo/tfjs/)
+* [Cross filtering millions of rows with cuDF](https://github.com/rapidsai/node/tree/main/modules/demo/client-server)
 * [Simulating & rendering with cuGraph](https://github.com/rapidsai/node/tree/main/modules/demo/graph/)
 * [Querying millions of points with cuSpatial](https://github.com/rapidsai/node/tree/main/modules/demo/spatial/)
 * [Multi-GPU SQL queries on GBs of CSVs](https://github.com/rapidsai/node/tree/main/modules/demo/sql/sql-cluster-server/)

modules/cudf/notebooks/README.md

@@ -0,0 +1,5 @@
+# Node.js Notebook Examples
+A series of data science and ETL notebooks to demonstrate [RAPIDS Bindings](https://github.com/rapidsai/node/blob/main/BINDINGS.md) coverage and functionality. Start with `Basic Demo.ipynb`!
+
+## Data Requirements
+Most notebooks contain built-in data creation or download functions. Check [SOURCES.md](https://github.com/rapidsai/node/blob/main/modules/cudf/notebooks/SOURCES.md) for details.

modules/demo/README.md

@@ -1,40 +1,106 @@
 # Node RAPIDS Demos
-A collection of demos, templates, and applications showcasing the features and uses for Node RAPIDS. 
+### A collection of demos, templates, and applications showcasing the features and uses for Node RAPIDS.
 
-## Featured
-- Viz Streaming App (link, image and video...)
-- Graph Visualization
-- UMAP Visualization
+<br/>
 
-## Server Side Rendering
-- Luma.gl Streaming demo
-- Graph Streaming demo
+## Starting Demos
+In a properly configured env or docker container, most demos can be selected from a list and started with:
+```bash
+yarn demo
+```
 
-## Client Side Rendering App
-- Client-Server Dashboard 
+Or directly with:
+```bash
+yarn demo modules/demo/graph
+```
 
-## Deck.gl and Luma.gl
-- Deck.GL examples
-- Luma lessons
+Or in most cases within each demo's folder with:
+```bash
+yarn start
+```
 
-## Spatial
-- Spatial compute demo
+## Data Requirements
+Some demos require downloading datasets to run, while others have defaults included. See each demo's README for details.
 
-## SQL
-- SQL engine and frontend demo
+<br/><br/>
 
-## IPC
-- 
+# Demos List
 
-## Misc
-- Tensorflow-js weblGL tests
-- Tensorflow-js RNN addition 
-- Xterm GL rendering
 
-## Data Requirements
-Some demos require datasets to run, see their individual readme for details. 
+## [Viz App](https://github.com/rapidsai/node/tree/main/modules/demo/viz-app) + [SSR Graph](https://github.com/rapidsai/node/tree/main/modules/demo/ssr/graph) | [YouTube Demo](https://youtu.be/zzOCIJ-K1dE)
+### Streaming SSR graph visualization with nvENC webRTC to a browser app, using cuDF and cuGraph bindings *Note: future demo will have simplified startup*
+![streaming ssr graph app](../../docs/images/demo-screenshots/streaming-graph-demo-ss2-sm.png)
+
+<br/><br/>
+
+## [Viz App](https://github.com/rapidsai/node/tree/main/modules/demo/viz-app) + [SSR Point Cloud](https://github.com/rapidsai/node/tree/main/modules/demo/ssr/graph) | [YouTube Demo](https://youtu.be/vCAiKIkCP3E)
+### Streaming SSR point cloud visualization with nvENC webRTC to a browser *Note: future demo will have simplified startup*
+![streaming ssr point cloud](../../docs/images/demo-screenshots/streaming-pointcloud-ss-sm.png)
+
+<br/><br/>
+
+## [Client Server](https://github.com/rapidsai/node/tree/main/modules/demo/client-server) | [YouTube Demo](https://youtu.be/H8E0HLiL9YA)
+### Browser crossfilter visualization app with server side compute using cuDF
+![streaming ssr point cloud](../../docs/images/demo-screenshots/client-server-ss2-sm.png)
+
+<br/><br/>
+
+## [SQL](https://github.com/rapidsai/node/tree/main/modules/demo/sql/sql-cluster-server) | [YouTube Demo](https://youtu.be/EmwcMM_mYKA)
+### Demo of multi-GPU SQL demo w/ a browser UI query builder
+![streaming ssr point cloud](../../docs/images/demo-screenshots/sql-ss-sm.png)
+
+<br/><br/>
+
+## [Node.js Notebook](https://github.com/rapidsai/node/tree/main/modules/cudf/notebooks) | [YouTube Demo](https://youtu.be/LbHpK8M3cV4)
+### GPU accelerated data science in JupyterLab Notebook with Node.js
+![streaming ssr point cloud](../../docs/images/demo-screenshots/jupyterlab-nodejs-ss-sm.png)
+
+<br/><br/>
+
+## [Spatial](https://github.com/rapidsai/node/tree/main/modules/demo/spatial)
+### Using cuSpatial bindings of Quadtree to segment geospatial data
+![Spatial](../../docs/images/demo-screenshots/spatial-ss-sm.png)
+
+<br/><br/>
+
+## [Graph](https://github.com/rapidsai/node/tree/main/modules/demo/graph)
+### Using cuGraph bindings of FA2 to compute graph layout
+![Spatial](../../docs/images/demo-screenshots/graph-demo-ss-sm.png)
+
+<br/><br/>
+
+## [UMAP](https://github.com/rapidsai/node/tree/main/modules/demo/umap)
+### Using cuML bindings of UMAP to compute clusters
+![UMAP](../../docs/images/demo-screenshots/umap-ss-sm.png)
+
+<br/><br/>
+
+## [Deck.gl](https://github.com/rapidsai/node/tree/main/modules/demo/deck) | [Examples Page](https://deck.gl/examples)
+### Running Deck.gl examples with OpenGL Server Side
+![Deck.gl](../../docs/images/demo-screenshots/deck-gl-rides-ss-sm.png)
+
+<br/><br/>
+
+## [Luma.gl](https://github.com/rapidsai/node/tree/main/modules/demo/luma) | [Examples Page](https://luma.gl/examples)
+### Running (older) Luma.gl examples with OpenGL Server Side
+![Luma.gl](../../docs/images/demo-screenshots/luma-ss-sm.png)
+
+<br/><br/>
+
+## Misc Demos
+### [Xterm](https://github.com/rapidsai/node/tree/main/modules/demo/xterm) | Emulating GPU rendered xterminal
+### [tfjs weblGL](https://github.com/rapidsai/node/tree/main/modules/demo/tfjs/webgl-tests) | ( **Deprecated** ) bindings to tensorflow-js webGl test
+### [tfjs RNN addition](https://github.com/rapidsai/node/tree/main/modules/demo/tfjs/addition-rnn) | ( **Deprecated** ) bindings to tensorflow-js addition demo
+### [IPC](https://github.com/rapidsai/node/tree/main/modules/demo/ipc) | ( **Deprecated** ) Demo of Inter Process Communication between Python and Node.js
+
+
+<br/><br/>
+
+# Troubleshooting
+## My GLFW window is blank:
+If you have more than one GPU, for windowed (no browser) demos you must specify a display GPU by setting: `NVIDIA_VISIBLE_DEVICES=1` in the `.env` file, or docker command. Sometimes it takes a few seconds for things to load too.
 
-## Start
-Most demos can be started anywhere with: `yarn demo`, then selected from a list.
-Or started directly with a directory, such as: `yarn demo modules/demo/graph`
-Or with `yarn start` in the demo's own directory. 
+## Starting the demo produced an error:
+Make sure you have downloaded the required datasets, the data is not malformed, and it is in the correct location -usually `/data`.
+If that does not work and if you are running a locally built environment, try rebuilding the module.
+Some demo's may have stopped working - check our **[Issues](https://github.com/rapidsai/node/issues)** for details.

modules/demo/client-server/README.md

@@ -15,7 +15,7 @@ This demo showcases how to use cudf as a backend compute engine for a client-sid
 
 ## Data Requirements
 ### Uber Movement Dataset
-The data needs to be downloaded from [Uber Movements P](https://movement.uber.com/explore/san_francisco/travel-times) with the following sequence of actions:
+The data needs to be downloaded from [Uber Movements](https://movement.uber.com/explore/san_francisco/travel-times) with the following sequence of actions:
 - `Click 'Download data' > Click 'All data' > Slect '2020 Quarter' > Download 'Travel Times By Date By Hour Buckets (All Days).csv'`(1.7gb)
 - Save the file as `san_fran_uber.csv` in the folder `/public/data`
 - If not already included, also download the `san_francisco_censustracts.geojson`(3.8mb) file into `/public/data`. NOTE: you may have to rename from a .json to .geojson extension.
@@ -25,7 +25,7 @@ The data needs to be downloaded from [Uber Movements P](https://movement.uber.co
 - Save the file as `mortgage.csv` in the folder `/public/data`
 
 ## Start
-Example of starting the demo, then open `http://localhost:3000`,
+Start with the command below, then open `http://localhost:3000`
 ```bash
 yarn start
 ```

modules/demo/deck/heatmap/README.md

@@ -0,0 +1,26 @@
+This is a minimal standalone version of the HeatmapLayer example
+on [deck.gl](http://deck.gl) website.
+
+### Usage
+
+Copy the content of this folder to your project.
+
+```bash
+# install dependencies
+npm install
+# or
+yarn
+# bundle and serve the app with webpack
+npm start
+```
+
+### Data format
+
+Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/screen-grid), showing Uber pickup locations in NYC. [Source](https://github.com/fivethirtyeight/uber-tlc-foil-response)
+
+To use your own data, check out
+the [documentation of HeatmapLayer](../../../docs/api-reference/aggregation-layers/heatmap-layer.md).
+
+### Basemap
+
+The basemap in this example is provided by [CARTO free basemap service](https://carto.com/basemaps). To use an alternative base map solution, visit [this guide](https://deck.gl/docs/get-started/using-with-map#using-other-basemap-services)

modules/demo/deck/interleaved-buffer/README.md

@@ -1,8 +1,8 @@
-<div align="center">
-   <img width="150" heigth="150" src="https://webpack.js.org/assets/icon-square-big.svg" />
-</div>
 
-## Example: Use deck.gl with Interleaved Binary Data
+<img width="50" heigth="50" src="https://webpack.js.org/assets/icon-square-big.svg" />
+
+
+## Use deck.gl with Interleaved Binary Data
 
 ## Usage
 

modules/demo/deck/worldmap/README.md

@@ -0,0 +1,14 @@
+This is a minimal standalone version of the Worldmap example on [deck.gl](http://deck.gl) website.
+
+### Usage
+
+Copy the content of this folder to your project.
+
+```bash
+# install dependencies
+npm install
+# or
+yarn
+# bundle and serve the app with webpack
+npm start
+```

modules/demo/graph/README.md

@@ -2,11 +2,11 @@
 A simple graph visualization powered by cuGraph and deck.gl, using a glfw instance. While running, you can select parameters by using the up/down arrow keys or 1-9 and adjust by using left/right arrow keys. Pan and zoom with a mouse.
 
 ## Featured Dependencies
-@rapidsai/cudf
-@rapidsai/cuspatial
-@rapidsai/jsdom
-@rapidsai/deckgl
-@rapidsai/glfw
+- @rapidsai/cudf
+- @rapidsai/cuspatial
+- @rapidsai/jsdom
+- @rapidsai/deckgl
+- @rapidsai/glfw
 
 ## Data Requirements
 Without passing data, graph demo will default to internal data. Passing graph data assumes a node and edge `.csv` format in `/data` folder.

modules/demo/ipc/README.md

@@ -0,0 +1,2 @@
+# Inter Process Communication (IPC) - Depricated
+Early demo showing how to use IPC handles from Python with Node.js.

modules/demo/luma/README.md

@@ -1,9 +1,11 @@
-## Luma.GL Lessons Demo
-Running [Luma.gl](https://luma.gl/) lessons in a glfw instance, based on [webGL lessons](https://github.com/tparisi/webgl-lessons). Lessons 01 - 16 availble. 
+## Luma.gl Lessons Demo
+Running [Luma.gl](https://luma.gl/) lessons in a glfw instance, based on [webGL lessons](https://github.com/tparisi/webgl-lessons). Lessons 01 - 16 availble.
 
 ## Featured Dependencies
-@rapidsai/jsdom
-@rapidsai/glfw
+- @rapidsai/jsdom
+- @rapidsai/glfw
 
 Example of starting lesson 01:
-`yarn start 01`
+```bash
+yarn start 01`
+```