Add Dockerfile

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v5.0.0
+      hooks:
+          - id: check-toml
+          - id: check-yaml
+          - id: end-of-file-fixer
+            types: [python]
+          - id: trailing-whitespace
+          - id: requirements-txt-fixer
+          - id: check-added-large-files
+            args: ["--maxkb=500"]
+
+    - repo: https://github.com/psf/black
+      rev: 25.1.0
+      hooks:
+          - id: black-jupyter
+
+    - repo: https://github.com/codespell-project/codespell
+      rev: v2.4.1
+      hooks:
+          - id: codespell
+            args:
+                [
+                    "--ignore-words-list=aci,acount,acounts,fallow,ges,hart,hist,nd,ned,ois,wqs,watermask,tre,mape",
+                    "--skip=*.csv,*.geojson,*.json,*.yml*.js,*.html,*cff,*.pdf",
+                ]
+
+    - repo: https://github.com/kynan/nbstripout
+      rev: 0.8.1
+      hooks:
+          - id: nbstripout

Dockerfile

@@ -0,0 +1,19 @@
+FROM quay.io/jupyter/base-notebook:latest
+
+RUN mamba install -c conda-forge leafmap maplibre voila -y && \
+    pip install -U leafmap && \
+    fix-permissions "${CONDA_DIR}" && \
+    fix-permissions "/home/${NB_USER}"
+
+WORKDIR /home/jovyan
+USER jovyan
+
+RUN mkdir ./notebooks
+
+COPY run.sh .
+
+EXPOSE 8866
+
+HEALTHCHECK CMD curl --fail http://localhost:8866/_stcore/health
+
+CMD ["/bin/bash", "run.sh"]

README.md

@@ -1,3 +1,21 @@
 # leafmap-voila
 
 Build a docker image for using leafmap with Voila
+
+To build the image:
+
+```bash
+docker buildx build --platform linux/amd64,linux/arm64 -t giswqs/leafmap:voila --push .
+```
+
+To run the image:
+
+```bash
+docker run -it -p 8866:8866 -v $(pwd):/home/jovyan/notebooks giswqs/leafmap:voila
+```
+
+To push the image to the registry:
+
+```bash
+docker push giswqs/leafmap:voila
+```

notebooks/intro.ipynb

@@ -0,0 +1,45 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import leafmap.maplibregl as leafmap"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "m = leafmap.Map(style=\"liberty\")\n",
+    "m.add_basemap(\"Satellite\")\n",
+    "m"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "geo",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

requirements.txt

@@ -0,0 +1,3 @@
+voila
+leafmap
+maplibre

run.sh

@@ -0,0 +1 @@
+voila --Voila.ip=0.0.0.0 --no-browser --strip_sources=True --enable_nbextensions=True --MappingKernelManager.cull_interval=60 --MappingKernelManager.cull_idle_timeout=120 --NotebookClient.iopub_timeout=30 notebooks/