Skip to main content

Run the GeoLibre / whitebox_next_gen geospatial tool suite (WASM/WASI) from Python.

Project description

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 passed as bytes under /work; the tool reads/writes there and any new files come back as bytes.

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

Project details


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.4.1.tar.gz (6.2 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.4.1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: geolibre_wasm-0.4.1.tar.gz
  • Upload date:
  • Size: 6.2 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.4.1.tar.gz
Algorithm Hash digest
SHA256 8670f6e7c3fabedd98320ce7ccaca7816401053498e0603153a2b701d06ae9da
MD5 674e55d3340dcc485882bb1d8f4ffd31
BLAKE2b-256 318f35fe73aeb3ef21979ac33aa007ac6d29905c8e82e1aea3eb3a7d769f2cc3

See more details on using hashes here.

Provenance

The following attestation bundles were made for geolibre_wasm-0.4.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.4.1-py3-none-any.whl.

File metadata

  • Download URL: geolibre_wasm-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 6.5 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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ff5f35613b2b9f00c4bd31993a37c163440dee3da12b75ad1d43c7e787c92d03
MD5 4ca5cf12ab6142eb858acf907dbabae1
BLAKE2b-256 127366915e1fd8a2bdc6510d6af6daf49f8d3c52a807c052feeb8f2ee2c981ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for geolibre_wasm-0.4.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 Pingdom Monitoring Sentry Error logging StatusPage Status page