Initial commit

.github/workflows/sync-hf.yml

@@ -0,0 +1,20 @@
+name: Sync to Hugging Face hub
+on:
+  push:
+    branches: [main]
+
+  # to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  sync-to-hub:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          lfs: true
+      - name: Push to hub
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: git push --force https://giswqs:[email protected]/spaces/giswqs/leafmap-voila main

.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v6.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,20 @@
+FROM condaforge/mambaforge:latest
+
+# The HF Space container runs with user ID 1000.
+RUN useradd -m -u 1000 user
+USER user
+
+# Set home to the user's home directory
+ENV HOME=/home/user \
+  PATH=/home/user/.local/bin:$PATH
+
+# Set the working directory to the user's home directory
+WORKDIR $HOME/app
+COPY --chown=user . .
+
+RUN mamba env create --prefix $HOME/env  -f ./environment.yml
+
+EXPOSE 7860
+WORKDIR $HOME/app
+
+CMD ["mamba", "run", "-p", "/home/user/env", "--no-capture-output", "voila", "--no-browser", "notebooks/"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Open Geospatial Solutions
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,35 @@
+---
+title: Leafmap Voila
+emoji: 🚀
+colorFrom: red
+colorTo: red
+sdk: docker
+app_port: 7860
+tags:
+  - leafmap
+pinned: false
+short_description: A Voila template for leafmap
+license: mit
+---
+
+# 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 7860:7860 -v $(pwd):/home/jovyan/notebooks giswqs/leafmap:voila
+```
+
+To push the image to the registry:
+
+```bash
+docker push giswqs/leafmap:voila
+```

environment.yml

@@ -0,0 +1,12 @@
+name: voila
+channels:
+  - conda-forge
+dependencies:
+  - python=3.12
+  - pip
+  - ipykernel
+  - jupyterlab
+  - leafmap
+  - maplibre
+  - voila
+  - voila_topbar

notebooks/dashboard.ipynb

@@ -0,0 +1,119 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# %pip install leafmap"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import leafmap.maplibregl as leafmap\n",
+    "import ipywidgets as widgets"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "tw = leafmap.TabWidget(\n",
+    "    title=\"Interactive Dashboard\",\n",
+    "    tabs=(\"Home\", \"Map\", \"Population\", \"Settings\"),\n",
+    "    icons=(\"mdi-home\", \"mdi-airplane\", \"mdi-account-box\", \"mdi-cog\"),\n",
+    "    show_panel_titles=False,\n",
+    ")\n",
+    "\n",
+    "# Customize dialog\n",
+    "tw.set_help_title(\"About this dashboard\")\n",
+    "tw.set_help_content(\n",
+    "    widgets.HTML(\n",
+    "        \"\"\"\n",
+    "      <p><b>User Guide</b></p>\n",
+    "      <ul>\n",
+    "        <li>Step 1: Click on the tab</li>\n",
+    "        <li>Navigate the map</li>\n",
+    "        <li>? — help</li>\n",
+    "      </ul>\n",
+    "    \"\"\"\n",
+    "    )\n",
+    ")\n",
+    "\n",
+    "m = leafmap.Map(projection=\"globe\", sidebar_visible=True, height=\"600px\")\n",
+    "m.add_overture_3d_buildings()\n",
+    "m.create_container()\n",
+    "\n",
+    "home_tab = widgets.HTML(\n",
+    "    \"\"\"\n",
+    "    <h1>Welcome to the Leafmap Visualization Dashboard</h1>\n",
+    "    <p>This is the home tab.</p>\n",
+    "    <img src=\"https://assets.gishub.org/images/geog-312.png\" width=\"100%\">\n",
+    "    \"\"\"\n",
+    ")\n",
+    "\n",
+    "settings_tab = widgets.HTML(\n",
+    "    \"\"\"\n",
+    "    <h1>Settings</h1>\n",
+    "    <p>This is the settings tab.</p>\n",
+    "    \"\"\"\n",
+    ")\n",
+    "\n",
+    "data = \"https://github.com/opengeos/datasets/releases/download/vector/countries.geojson\"\n",
+    "\n",
+    "m2 = leafmap.Map(style=\"liberty\", projection=\"globe\")\n",
+    "first_symbol_id = m2.find_first_symbol_layer()[\"id\"]\n",
+    "m2.add_data(\n",
+    "    data,\n",
+    "    column=\"POP_EST\",\n",
+    "    scheme=\"Quantiles\",\n",
+    "    cmap=\"Blues\",\n",
+    "    legend_title=\"Population\",\n",
+    "    name=\"population\",\n",
+    "    # before_id=first_symbol_id,\n",
+    "    extrude=True,\n",
+    "    scale_factor=1000,\n",
+    ")\n",
+    "container = m2.create_container()\n",
+    "\n",
+    "tw.set_tab_content(0, home_tab)\n",
+    "tw.set_tab_content(1, m.container)\n",
+    "tw.set_tab_content(3, settings_tab)\n",
+    "tw.set_tab_content(2, m2.container)\n",
+    "\n",
+    "tw.widget"
+   ]
+  }
+ ],
+ "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": 5
+}

notebooks/leafmap.ipynb

@@ -0,0 +1,51 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import leafmap.maplibregl as leafmap"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "m = leafmap.Map(\n",
+    "    style=\"liberty\", projection=\"globe\", sidebar_visible=True, height=\"750px\"\n",
+    ")\n",
+    "m.add_basemap(\"USGS.Imagery\")\n",
+    "cities = (\n",
+    "    \"https://github.com/opengeos/datasets/releases/download/world/world_cities.geojson\"\n",
+    ")\n",
+    "m.add_geojson(cities, name=\"Cities\")\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
+}

voila.json

@@ -0,0 +1,11 @@
+{
+  "Voila": {
+    "ip":"0.0.0.0",
+    "port": 7860,
+    "tornado_settings": {
+      "headers": {
+        "Content-Security-Policy": "frame-ancestors self *"
+      }
+    }
+  }
+}