Merge pull request #2762 from finos/docs-31

Update `README.md`, examples and build dependencies

.github/actions/install-wheel/action.yaml

@@ -13,13 +13,23 @@
 name: "Install wheel"
 description: "Installs the wheel depending on build platform, because Python"
 
+inputs:
+    inplace:
+        default: "true"
+        description: "Install in-place?"
+
 runs:
     using: "composite"
     steps:
         - name: Install wheel (Linux)
           shell: sh
           run: python -m pip install -U --no-dependencies *.whl --target rust/perspective-python
-          if: ${{ runner.os == 'Linux' }}
+          if: ${{ inputs.inplace == 'true' && runner.os == 'Linux' }}
+
+        - name: Install wheel (Linux)
+          shell: sh
+          run: python -m pip install -U --no-dependencies *.whl
+          if: ${{ inputs.inplace != 'true' && runner.os == 'Linux' }}
 
         - name: Install wheel (OSX)
           shell: sh

.github/workflows/build.yaml

@@ -625,6 +625,8 @@ jobs:
                   name: perspective-python-dist-${{ matrix.arch }}-${{ matrix.os }}-${{ matrix.python-version }}
 
             - uses: ./.github/actions/install-wheel
+              with:
+                  inplace: "false"
 
             - name: Benchmarks
               run: pnpm run bench

README.md

@@ -3,10 +3,10 @@
 <a href="https://github.com/finos/perspective/blob/master/docs/static/svg/perspective-logo-dark.svg?raw=true#gh-dark-mode-only"><img src="https://github.com/finos/perspective/raw/master/docs/static/svg/perspective-logo-dark.svg?raw=true#gh-dark-mode-only" alt="Perspective" width="260"></a>
 <br/><br/>
 
-[![npm](https://img.shields.io/npm/v/@finos/perspective.svg?style=flat)](https://www.npmjs.com/package/@finos/perspective)
-[![PyPI](https://img.shields.io/pypi/v/perspective-python.svg?style=flat)](https://pypi.python.org/pypi/perspective-python)
-[![crates.io](https://img.shields.io/crates/v/perspective.svg?style=flat)](https://crates.io/crates/perspective)
-[![Build Status](https://github.com/finos/perspective/actions/workflows/build.yaml/badge.svg?branch=master&event=push)](https://github.com/finos/perspective/actions/workflows/build.yaml)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/finos/perspective/build.yaml?event=push&style=for-the-badge)](https://github.com/finos/perspective/actions/workflows/build.yaml)
+[![npm](https://img.shields.io/npm/v/@finos/perspective.svg?style=for-the-badge)](https://www.npmjs.com/package/@finos/perspective)
+[![PyPI](https://img.shields.io/pypi/v/perspective-python.svg?style=for-the-badge)](https://pypi.python.org/pypi/perspective-python)
+[![crates.io](https://img.shields.io/crates/v/perspective?style=for-the-badge)](https://crates.io/crates/perspective)
 
 <br/>
 
@@ -19,10 +19,10 @@ and/or [Jupyterlab](https://jupyterlab.readthedocs.io/en/stable/).
 ### Features
 
 -   A fast, memory efficient streaming query engine, written in C++ and compiled
-    for both [WebAssembly](https://webassembly.org/) and
-    [Python](https://www.python.org/), with read/write/streaming for
-    [Apache Arrow](https://arrow.apache.org/), and a high-performance columnar
-    expression language based on
+    for [WebAssembly](https://webassembly.org/),
+    [Python](https://www.python.org/) and [Rust](https://www.rust-lang.org/),
+    with read/write/streaming for [Apache Arrow](https://arrow.apache.org/), and
+    a high-performance columnar expression language based on
     [ExprTK](https://github.com/ArashPartow/exprtk).
 
 -   A framework-agnostic User Interface packaged as a
@@ -34,12 +34,6 @@ and/or [Jupyterlab](https://jupyterlab.readthedocs.io/en/stable/).
     interactive data analysis in a notebook, as well as _scalable_ production
     [Voila](https://github.com/voila-dashboards/voila) applications.
 
-### Examples
-
-<!-- Examples -->
-<table><tbody><tr><td>editable</td><td>file</td><td>fractal</td></tr><tr><td><a href="https://perspective.finos.org/block?example=editable"><img height="125" src="https://perspective.finos.org/blocks/editable/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=file"><img height="125" src="https://perspective.finos.org/blocks/file/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=fractal"><img height="125" src="https://perspective.finos.org/blocks/fractal/preview.png?"></img></a></td></tr><tr><td>market</td><td>raycasting</td><td>evictions</td></tr><tr><td><a href="https://perspective.finos.org/block?example=market"><img height="125" src="https://perspective.finos.org/blocks/market/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=raycasting"><img height="125" src="https://perspective.finos.org/blocks/raycasting/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=evictions"><img height="125" src="https://perspective.finos.org/blocks/evictions/preview.png?"></img></a></td></tr><tr><td>nypd</td><td>magic</td><td>streaming</td></tr><tr><td><a href="https://perspective.finos.org/block?example=nypd"><img height="125" src="https://perspective.finos.org/blocks/nypd/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=magic"><img height="125" src="https://perspective.finos.org/blocks/magic/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=streaming"><img height="125" src="https://perspective.finos.org/blocks/streaming/preview.png?"></img></a></td></tr><tr><td>covid</td><td>webcam</td><td>movies</td></tr><tr><td><a href="https://perspective.finos.org/block?example=covid"><img height="125" src="https://perspective.finos.org/blocks/covid/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=webcam"><img height="125" src="https://perspective.finos.org/blocks/webcam/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=movies"><img height="125" src="https://perspective.finos.org/blocks/movies/preview.png?"></img></a></td></tr><tr><td>superstore</td><td>citibike</td><td>olympics</td></tr><tr><td><a href="https://perspective.finos.org/block?example=superstore"><img height="125" src="https://perspective.finos.org/blocks/superstore/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=citibike"><img height="125" src="https://perspective.finos.org/blocks/citibike/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=olympics"><img height="125" src="https://perspective.finos.org/blocks/olympics/preview.png?"></img></a></td></tr><tr><td>jupyterlab</td></tr><tr><td><a href="http://beta.mybinder.org/v2/gh/finos/perspective/master?urlpath=lab/tree/examples/jupyter-notebooks"><img height="125" src="https://perspective.finos.org/img/jupyterlab.png?"></img></a></td></tr></tbody></table>
-<!-- Examples -->
-
 ### Documentation
 
 -   [Project Site](https://perspective.finos.org/)
@@ -57,10 +51,36 @@ and/or [Jupyterlab](https://jupyterlab.readthedocs.io/en/stable/).
     -   [Perspective Viewer API](https://perspective.finos.org/docs/obj/perspective-viewer/)
     -   [Perspective Python API](https://perspective.finos.org/docs/obj/perspective-python.html)
 
-### Community / Media
+### Examples
+
+<!-- Examples -->
+<table><tbody><tr><td>editable</td><td>file</td><td>fractal</td></tr><tr><td><a href="https://perspective.finos.org/block?example=editable"><img height="125" src="https://perspective.finos.org/blocks/editable/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=file"><img height="125" src="https://perspective.finos.org/blocks/file/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=fractal"><img height="125" src="https://perspective.finos.org/blocks/fractal/preview.png?"></img></a></td></tr><tr><td>market</td><td>raycasting</td><td>evictions</td></tr><tr><td><a href="https://perspective.finos.org/block?example=market"><img height="125" src="https://perspective.finos.org/blocks/market/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=raycasting"><img height="125" src="https://perspective.finos.org/blocks/raycasting/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=evictions"><img height="125" src="https://perspective.finos.org/blocks/evictions/preview.png?"></img></a></td></tr><tr><td>nypd</td><td>streaming</td><td>covid</td></tr><tr><td><a href="https://perspective.finos.org/block?example=nypd"><img height="125" src="https://perspective.finos.org/blocks/nypd/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=streaming"><img height="125" src="https://perspective.finos.org/blocks/streaming/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=covid"><img height="125" src="https://perspective.finos.org/blocks/covid/preview.png?"></img></a></td></tr><tr><td>webcam</td><td>movies</td><td>superstore</td></tr><tr><td><a href="https://perspective.finos.org/block?example=webcam"><img height="125" src="https://perspective.finos.org/blocks/webcam/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=movies"><img height="125" src="https://perspective.finos.org/blocks/movies/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=superstore"><img height="125" src="https://perspective.finos.org/blocks/superstore/preview.png?"></img></a></td></tr><tr><td>citibike</td><td>olympics</td><td>jupyterlab</td></tr><tr><td><a href="https://perspective.finos.org/block?example=citibike"><img height="125" src="https://perspective.finos.org/blocks/citibike/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=olympics"><img height="125" src="https://perspective.finos.org/blocks/olympics/preview.png?"></img></a></td><td><a href="http://beta.mybinder.org/v2/gh/finos/perspective/master?urlpath=lab/tree/examples/jupyter-notebooks"><img height="125" src="https://perspective.finos.org/img/jupyterlab.png?"></img></a></td></tr></tbody></table>
+<!-- Examples -->
+
+### Media
 
--   [Streaming Cross-Sectional Data Visualization with Perspective + Spark | Tim Bess/Tim Paine, Data + AI Summit 2024](https://www.youtube.com/watch?v=lDpIu4dnp78)
--   [Streaming, cross-sectional data visualization in JupyterLab | Junyuan Tan, JupyterCon 2020](http://www.youtube.com/watch?v=IO-HJsGdleE)
--   [Perspective in 3D | Andrew Stein, Open Source in Finance Forum NYC 2022](https://www.youtube.com/watch?v=0ut-ynvBpGI)
--   [Build an order book simulation with Perspective | Andrew Stein, FINOS Open Source in Fintech Meetup 2021](https://www.youtube.com/watch?v=no0qChjvdgQ)
--   [Perspective project case study | FINOS](https://www.finos.org/hubfs/FINOS/assets/FINOS%20Perspective%20Case%20Study.pdf)
+<table><tbody>
+<tr>
+<td><a href="https://github.com/timkpaine"><code>@timkpaine</code></a></td>
+<td><a href="https://github.com/timbess"><code>@timbess</code></a></td>
+<td><a href="https://github.com/sc1f"><code>@sc1f</code></a></td>
+</tr>
+<tr><td>
+<a href="https://www.youtube.com/watch?v=s6n9vEyM1gY"><img width="240" src="https://img.youtube.com/vi/s6n9vEyM1gY/0.jpg" /></a>
+</td><td>
+<a href="https://www.youtube.com/watch?v=lDpIu4dnp78"><img width="240" src="https://img.youtube.com/vi/lDpIu4dnp78/0.jpg" /></a>
+</td><td>
+<a href="https://www.youtube.com/watch?v=IO-HJsGdleE"><img width="240"  src="https://img.youtube.com/vi/IO-HJsGdleE/0.jpg" /></a>
+</td></tr>
+<tr>
+<td><a href="https://github.com/texodus"><code>@texodus</code></a></td>
+<td><a href="https://github.com/texodus"><code>@texodus</code></a></td>
+<td></td>
+</tr>
+<tr><td>
+<a href="https://www.youtube.com/watch?v=0ut-ynvBpGI"><img width="240" src="https://img.youtube.com/vi/0ut-ynvBpGI/0.jpg" /></a>
+</td><td>
+<a href="https://www.youtube.com/watch?v=no0qChjvdgQ"><img width="240" src="https://img.youtube.com/vi/no0qChjvdgQ/0.jpg" /></a>
+</td><td>
+</td></tr>
+</tbody></table>

cpp/perspective/src/cpp/arrow_csv.cpp

@@ -609,11 +609,11 @@ csvToTable(
     auto read_options = arrow::csv::ReadOptions::Defaults();
     auto parse_options = arrow::csv::ParseOptions::Defaults();
     auto convert_options = arrow::csv::ConvertOptions::Defaults();
-    #ifdef PSP_PARALLEL_FOR
-        read_options.use_threads = true;
-    #else
-        read_options.use_threads = false;
-    #endif
+#ifdef PSP_PARALLEL_FOR
+    read_options.use_threads = true;
+#else
+    read_options.use_threads = false;
+#endif
     parse_options.newlines_in_values = true;
 
     if (is_update) {

cpp/perspective/src/cpp/view.cpp

@@ -1211,11 +1211,11 @@ View<CTX_T>::data_slice_to_arrow(
         options.codec = std::move(codec).ValueUnsafe();
     }
 
-    #ifdef PSP_PARALLEL_FOR
-        options.use_threads = true;
-    #else
-        options.use_threads = false;
-    #endif
+#ifdef PSP_PARALLEL_FOR
+    options.use_threads = true;
+#else
+    options.use_threads = false;
+#endif
 
     auto res = arrow::ipc::MakeStreamWriter(&sink, arrow_schema, options);
     std::shared_ptr<arrow::ipc::RecordBatchWriter> writer = *res;

docs/package.json

@@ -26,7 +26,7 @@
         "clsx": "^2.0.0",
         "mkdirp": "3",
         "prism-react-renderer": "^1.3.3",
-        "puppeteer": "22.10.0",
+        "puppeteer": "^23",
         "react": "^18.0.0",
         "react-dom": "^18.0.0",
         "superstore-arrow": "3.0.0"

examples/blocks/examples.js

@@ -18,7 +18,6 @@ const LOCAL_EXAMPLES = [
     "raycasting",
     "evictions",
     "nypd",
-    "magic",
     "streaming",
     "covid",
     "webcam",

examples/blocks/src/editable/index.html

@@ -7,7 +7,6 @@
         <script type="module" src="/node_modules/@finos/perspective-viewer-datagrid/dist/cdn/perspective-viewer-datagrid.js"></script>
         <script type="module" src="/node_modules/@finos/perspective-viewer-d3fc/dist/cdn/perspective-viewer-d3fc.js"></script>
 
-        <link rel="preload" href="/node_modules/@finos/perspective/dist/cdn/perspective-server.js" as="fetch" type="application/javascript" crossorigin="anonymous" />
         <link rel="preload" href="/node_modules/@finos/perspective/dist/cdn/perspective-server.wasm" as="fetch" type="application/wasm" crossorigin="anonymous" />
         <link rel="preload" href="/node_modules/@finos/perspective-viewer/dist/cdn/perspective-viewer.wasm" as="fetch" type="application/wasm" crossorigin="anonymous" />
         <link rel="preload" href="/node_modules/superstore-arrow/superstore.lz4.arrow" as="fetch" type="arraybuffer" crossorigin="anonymous" />