Skip to main content

geolibre-wasm (Python)

Run the geolibre-rust geospatial tool suite (the whitebox_next_gen tools plus GeoLibre's own) from Python. The tools are a single WebAssembly (WASI) module executed in-process via wasmtime, so there is no native install, no GDAL, and no server — just pip install.

This mirrors the JavaScript geolibre-wasm/tools API (list_tools, list_manifests, run_tool), so the two stay in sync.

The import package is geolibre_wasm (the distribution is geolibre-wasm), matching the npm package name and avoiding a clash with the separate geolibre application package.

Install

pip install geolibre-wasm

On first use the runtime (geolibre-cli.wasm, ~20 MB) is downloaded from the matching GitHub release and cached under ~/.cache/geolibre/. To use a local copy instead, set GEOLIBRE_WASM=/path/to/geolibre-cli.wasm or pass wasm_path= to any call.

Usage

Inputs are placed under /work; the tool reads/writes there and any new files come back as bytes. Each input value may be bytes, an http(s) URL to download, or a local file path -- the same for raster and vector inputs:

res = gl.run_tool(
    "write_geoparquet",
    args=["--input=/work/in.geojson", "--output=/work/out.parquet"],
    input={"in.geojson": "https://example.com/data/cities.geojson"},  # fetched for you
)

This downloads the whole file (no HTTP range reads). Works for cog.tif, data.parquet, data.fgb, data.geojson, etc.

Paths are sandboxed. Every path inside args refers to the tool's /work filesystem, not your host disk. input files are placed at /work/<name>, and res.files keys are paths relative to /work. Do your own open() / write() against host paths (e.g. /content/... on Colab) on the Python side, never inside args.

import geolibre_wasm as gl

# Discover tools (each manifest carries a "source": "geolibre" | "whitebox")
tools = gl.list_tools()
manifests = gl.list_manifests()

# Raster: compute slope from a DEM
dem = open("dem.tif", "rb").read()                     # read from host disk
res = gl.run_tool(
    "slope",
    args=["--input=/work/dem.tif", "--output=/work/slope.tif", "--units=degrees"],
    input={"dem.tif": dem},                            # -> /work/dem.tif
)
assert res.exit_code == 0, res.stdout                  # surfaces tool errors
open("slope.tif", "wb").write(res.files["slope.tif"])  # key is relative to /work

# Reproject (warp) to a target EPSG
res = gl.run_tool(
    "reproject_raster",
    args=["--input=/work/dem.tif", "--output=/work/wgs84.tif", "--epsg=4326"],
    input={"dem.tif": dem},
)

# Vector: GeoJSON -> GeoParquet (Hilbert-sorted, bbox covering, ZSTD by default)
gj = open("cities.geojson", "rb").read()
res = gl.run_tool(
    "write_geoparquet",
    args=["--input=/work/in.geojson", "--output=/work/out.parquet"],
    input={"in.geojson": gj},
)
open("cities.parquet", "wb").write(res.files["out.parquet"])

Tools that write a directory tree (e.g. raster_to_tiles) return nested keys:

res = gl.run_tool(
    "raster_to_tiles",
    args=["--input=/work/dem.tif", "--output_dir=/work/tiles", "--min_zoom=16", "--max_zoom=18"],
    input={"dem.tif": dem},
)
for path, data in res.files.items():
    # e.g. "tiles/16/9559/32767.png"
    ...

API

  • list_tools(wasm_path=None) -> list[str]
  • list_manifests(wasm_path=None) -> list[dict]
  • run_tool(tool, args=None, input=None, wasm_path=None) -> ToolResult
  • ToolResult(exit_code: int, stdout: list[str], files: dict[str, bytes])
  • runtime_path(wasm_path=None) -> str — resolve the runtime (explicit > GEOLIBRE_WASM > cached download)
  • download_runtime(dest=None) -> str — fetch the runtime ahead of time

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geolibre_wasm-0.5.1.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

geolibre_wasm-0.5.1-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file geolibre_wasm-0.5.1.tar.gz.

File metadata

  • Download URL: geolibre_wasm-0.5.1.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for geolibre_wasm-0.5.1.tar.gz
Algorithm Hash digest
SHA256 769061218166d507159dbe59fc78356406e98846db3acc7f347ce679d5f675be
MD5 a8a06a3619df956d4319c18b10ae3de8
BLAKE2b-256 8caca3df9b79aed4d9ed75ecd924b8f374ff382b253dc33520ac21914ac6bc9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for geolibre_wasm-0.5.1.tar.gz:

Publisher: release.yml on opengeos/geolibre-rust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file geolibre_wasm-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: geolibre_wasm-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for geolibre_wasm-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f14059de57a945bfdb02e6c1f2fb016222f59ce97172b210dee8355de7e27fde
MD5 1e700d7772ea4d1da100c1bb26831c9a
BLAKE2b-256 14466bf32591a36c1f4587d5103a37ce3be3f946ff424bd16c8bab73f0c05032

See more details on using hashes here.

Provenance

The following attestation bundles were made for geolibre_wasm-0.5.1-py3-none-any.whl:

Publisher: release.yml on opengeos/geolibre-rust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page