Skip to content

Commit

Permalink
Pyodide docs stub
Browse files Browse the repository at this point in the history
  • Loading branch information
kylebarron committed Oct 3, 2024
1 parent 667dfed commit 55a34a6
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/ecosystem/pyodide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Using in pyodide

As of Lonboard version 0.10, it's possible to use Lonboard in [Pyodide](https://pyodide.org/en/stable/), where Python is running _inside your web browser_ in WebAssembly.

[![](../../assets/lonboard-jupyterlite.png)][Jupyterlite demo]

[**Demo notebook**][Jupyterlite demo].

[Jupyterlite demo]: https://jupyterlite.ds.io/lab/index.html?path=lonboard%2Fdata-filter-extension.ipynb

There's a few things to keep in mind:

### Pyodide-specific dependencies

Not all Python libraries work out of the box in Pyodide. Any Python libraries that use compiled code need to be loaded in Pyodide with special wheels.

Lonboard does not use compiled code itself, but some of its dependencies — namely [`arro3`](https://github.com/kylebarron/arro3) — use compiled code. You may need to manually load `arro3` wheels before importing `lonboard`. Refer to the demo notebook for an example.

### Memory limits

Pyodide has stricter memory limits than normal Python environments. Take care to delete Python objects you're no longer using with `del`.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ nav:
- ecosystem/geopandas.md
- ecosystem/duckdb.md
- ecosystem/geoarrow.md
- ecosystem/pyodide.md
- ecosystem/jupyter-widgets.md
- ecosystem/panel.md
- ecosystem/shiny.md
Expand Down

0 comments on commit 55a34a6

Please sign in to comment.