MapManager Web Components

Reusable browser components shared by MapManager web and Python/NiceGUI clients.

Packages

• @mapmanager/image-viewer — a Deck.gl/Viv scientific image viewer for in-memory planes, lazy planes, and OME-Zarr. It is used by AcqView.
• @mapmanager/nicepool — linked statistical plots, selection, summaries, a Vue component, and a framework-neutral Custom Element. It is used by CloudScope Web.

Both packages are actively developed and pre-1.0. Their APIs may change when that improves the design; user-visible changes belong in the changelog.

Integrations and examples

• nicepool-anywidget is a thin Python and Jupyter adapter around the existing NicePool custom element.
• nicepool-pyqt5 embeds the existing NicePool custom element in a reusable PyQt5 widget.
• examples/jupyter/nicepool-anywidget.ipynb demonstrates that adapter from Python.
• packages/nicepool/notebooks/01-nicepool-engine.ipynb demonstrates the framework-independent NicePool engine using a Deno kernel.

Integration-specific Python dependencies are isolated from the normal npm installation. See each integration's README for its setup commands.

Documentation

The complete documentation is published at mapmanager.github.io/mapmanager-web-components. The Markdown source is in docs/.

Development

npm ci
npm run check
npm run dev --workspace @mapmanager/image-viewer
npm run dev --workspace @mapmanager/nicepool

See the development guide for focused commands and the documentation workflow. The repository is licensed under GPL-3.0-only.

Documentation site

Install uv once, then run the local documentation site through npm:

npm run docs:serve

Open http://127.0.0.1:8000/. MkDocs rebuilds the site as its Markdown source changes; stop the server with Ctrl+C.

Validate the production documentation build with:

npm run docs:build

The npm commands ask uv to create an isolated environment from requirements-docs.txt; there is no repository virtual environment to activate or commit.