smart-geocubes 0.0.1__tar.gz

smart_geocubes-0.0.1/.github/workflows/update_version.yml

@@ -0,0 +1,131 @@
+name: Update Version
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump:
+        description: 'The version bump to apply [possible values: major, minor, patch]'
+        required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+      publish:
+        description: 'Publish the package to GitHub releases and PyPI?'
+        required: false
+        type: boolean
+        default: true
+
+jobs:
+  update-version:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    outputs:
+      VERSION: ${{ steps.update_version.outputs.tag-number }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # Do a version bump on the package
+      - name: Update version by bumping git tag
+        id: update_version
+        uses: leonsteinhaeuser/git-tag-bump@v1.1.0
+        with:
+          args: >-
+            --bump ${{ github.event.inputs.bump }} --v-prefix --create --actor-name "GitHub Actions" --actor-mail "github-actions[bot]@users.noreply.github.com"
+
+  build-and-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - update-version
+    permissions:
+      contents: write
+      id-token: write
+
+    if: github.event.inputs.publish
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: '0.6.7'
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Build package
+        run: uv build
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ needs.update-version.outputs.VERSION }}
+          release_name: Release ${{ needs.update-version.outputs.VERSION }}
+          draft: false
+          prerelease: false
+
+      - name: Publish to PyPI
+        run: uv publish --trusted-publishing always
+
+  build-and-publish-docs:
+    runs-on: ubuntu-latest
+    needs:
+      - update-version
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: '0.6.7'
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Get cache id
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material
+
+      - name: Install dependencies
+        run: uv sync --all-extras --group docs
+
+      - name: Install dependencies
+        run: uv sync --all-extras --group docs
+
+      - name: Publish documentation
+        run: uv run mike deploy --push --update-aliases ${{ needs.update-version.outputs.VERSION }} latest

smart_geocubes-0.0.1/.gitignore

@@ -0,0 +1,16 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# data
+data
+
+# Playground
+playground.ipynb

smart_geocubes-0.0.1/.python-version

@@ -0,0 +1 @@
+3.13.2

smart_geocubes-0.0.1/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

smart_geocubes-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tobias Hölzer
+
+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.

smart_geocubes-0.0.1/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: smart-geocubes
+Version: 0.0.1
+Summary: A high-performance library for intelligent loading and caching of remote geospatial raster data, built with xarray and zarr.
+Project-URL: Documentation, https://relativityhd.github.io/smart-geocubes/latest/
+Project-URL: Repository, https://github.com/relativityhd/smart-geocubes
+Project-URL: Issues, https://github.com/relativityhd/smart-geocubes/issues
+Author-email: relativityhd <tobiashoelzer@hotmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: geopandas>=1.0.1
+Requires-Dist: icechunk<0.3,>=0.2.5
+Requires-Dist: numcodecs<0.16,>=0.15.0
+Requires-Dist: numpy<3,>=1.20
+Requires-Dist: odc-geo<0.5,>=0.4.5
+Requires-Dist: stopuhr>=0.0.3
+Requires-Dist: xarray>=2025.1.1
+Requires-Dist: zarr<4,>=3
+Provides-Extra: dask
+Requires-Dist: bokeh>=3.6.3; extra == 'dask'
+Requires-Dist: dask>=2025.1.0; extra == 'dask'
+Requires-Dist: distributed>=2025.1.0; extra == 'dask'
+Provides-Extra: gee
+Requires-Dist: earthengine-api>=1.1.5; extra == 'gee'
+Requires-Dist: rasterio>=1.4.3; extra == 'gee'
+Requires-Dist: rioxarray>=0.18.2; extra == 'gee'
+Requires-Dist: xee>=0.0.20; extra == 'gee'
+Provides-Extra: stac
+Requires-Dist: odc-stac>=0.3.11; extra == 'stac'
+Requires-Dist: pystac-client>=0.8.5; extra == 'stac'
+Requires-Dist: pystac>=1.12.1; extra == 'stac'
+Requires-Dist: xpystac>=0.1.3; extra == 'stac'
+Provides-Extra: viz
+Requires-Dist: cartopy>=0.24.1; extra == 'viz'
+Requires-Dist: folium>=0.19.4; extra == 'viz'
+Requires-Dist: mapclassify>=2.8.1; extra == 'viz'
+Requires-Dist: matplotlib>=3.10.0; extra == 'viz'
+Description-Content-Type: text/markdown
+
+# Smart Geocubes
+
+A high-performance library for intelligent loading and caching of remote geospatial raster data, built with xarray, zarr and icechunk.
+
+## Development
+
+Install for everything:
+
+```sh
+uv sync --all-extras --all-groups
+```
+
+### Roadmap
+
+Features:
+
+- [ ] STAC: Add dask download as optional
+- [x] STAC: Make the progress-bar optional
+- [ ] Overall: Add support for temporal axis
+- [ ] Overall: Add support for 3D data
+- [ ] Overall: Add support for 4D data
+- [X] GEE Accessor
+- [ ] Widen support for lat-lon data
+- [ ] Support different x-y resolutions
+- [ ] True threaded mode: multiple threads for downloading, one thread for writing, multiple for loading
+
+Datasets:
+
+- [X] ArcticDEM: increase readspeed by using extent files
+- [X] TCTrend Dataset
+- [ ] S2 Dataset
+- [ ] Landsat Dataset
+
+Admin:
+
+- [X] Use StopUhr to measure performance
+- [ ] Write documentation (sphinx or mkdocs)
+- [ ] Add GitHub Action
+- [ ] Publish to PyPy

smart_geocubes-0.0.1/README.md

@@ -0,0 +1,39 @@
+# Smart Geocubes
+
+A high-performance library for intelligent loading and caching of remote geospatial raster data, built with xarray, zarr and icechunk.
+
+## Development
+
+Install for everything:
+
+```sh
+uv sync --all-extras --all-groups
+```
+
+### Roadmap
+
+Features:
+
+- [ ] STAC: Add dask download as optional
+- [x] STAC: Make the progress-bar optional
+- [ ] Overall: Add support for temporal axis
+- [ ] Overall: Add support for 3D data
+- [ ] Overall: Add support for 4D data
+- [X] GEE Accessor
+- [ ] Widen support for lat-lon data
+- [ ] Support different x-y resolutions
+- [ ] True threaded mode: multiple threads for downloading, one thread for writing, multiple for loading
+
+Datasets:
+
+- [X] ArcticDEM: increase readspeed by using extent files
+- [X] TCTrend Dataset
+- [ ] S2 Dataset
+- [ ] Landsat Dataset
+
+Admin:
+
+- [X] Use StopUhr to measure performance
+- [ ] Write documentation (sphinx or mkdocs)
+- [ ] Add GitHub Action
+- [ ] Publish to PyPy

smart_geocubes-0.0.1/docs/getting_started.md

@@ -0,0 +1,4 @@
+# Getting Started
+
+Sorry, nothing to see here yet. Check back later!
+Until then, check the [Reference](reference/smart_geocubes/index.md).

smart_geocubes-0.0.1/docs/index.md

@@ -0,0 +1,8 @@
+---
+hide:
+  - navigation
+---
+
+# Smart-Geocubes
+
+A high-performance library for intelligent loading and caching of remote geospatial raster data, built with xarray, zarr and icechunk.

smart_geocubes-0.0.1/docs/overrides/main.html

@@ -0,0 +1,12 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+You're not viewing the latest version.
+<a href="{{ '../' ~ base_url }}">
+    <strong>Click here to go to latest.</strong>
+</a>
+{% endblock %}
+
+{% block announce %}
+Smart-Geocubes is in early Alpha!
+{% endblock %}

smart_geocubes-0.0.1/examples/usage.ipynb

@@ -0,0 +1,105 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "OUT-OF-DATE!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Use Case 1: Open a pre-configured dataset, e.g. ArcticDEM\n",
+    "\n",
+    "import xarray as xr\n",
+    "\n",
+    "from smart_geocubes.datasets import ArcticDEM32m\n",
+    "\n",
+    "ndvi: xr.DataArray = ...\n",
+    "\n",
+    "adem32 = ArcticDEM32m.load_like(ndvi, \"data/arcticdem/32m/\")\n",
+    "\n",
+    "assert ndvi.crs == adem32.crs, ndvi.shape == adem32.shape"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Use Case 2: Open a pre-configured dataset, e.g. ArcticDEM, with a specific bounding box#\n",
+    "\n",
+    "from odc.geo.geobox import GeoBox\n",
+    "\n",
+    "from smart_geocubes.datasets import ArcticDEM32m\n",
+    "\n",
+    "geobox: GeoBox = ...\n",
+    "\n",
+    "adem32 = ArcticDEM32m.load(geobox, \"data/arcticdem/32m/\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Use Case 3: Configure cache chunks and encoding for an existing dataset\n",
+    "\n",
+    "from odc.geo.geobox import GeoBox\n",
+    "\n",
+    "from smart_geocubes.datasets import ArcticDEM32m\n",
+    "\n",
+    "geobox: GeoBox = ...\n",
+    "\n",
+    "adem32 = ArcticDEM32m.load(geobox, \"data/arcticdem/32m/\", chunk_size=512, data_vars_encoding={\"zlib\": True})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Use Case 4: Define a new dataset with a custom configuration\n",
+    "from typing import ClassVar\n",
+    "\n",
+    "from odc.geo.geobox import GeoBox\n",
+    "\n",
+    "from smart_geocubes.accessors import STACAccessor\n",
+    "\n",
+    "\n",
+    "class MyDataset(STACAccessor):\n",
+    "    \"\"\"Custom STAC dataset.\"\"\"\n",
+    "\n",
+    "    chunk_size = 512\n",
+    "    data_vars_encoding: ClassVar[dict] = {\"zlib\": True}\n",
+    "    stac_api_url = \"https://example.com/stac\"\n",
+    "    collection = \"my-collection\"\n",
+    "\n",
+    "\n",
+    "geobox: GeoBox = ...\n",
+    "\n",
+    "adem32 = MyDataset.load(geobox, \"data/arcticdem/32m/\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.11.10"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

smart_geocubes-0.0.1/mkdocs.yml

@@ -0,0 +1,160 @@
+site_name: Smart-Geocubes
+site_url: https://relativityhd.github.io/smart-geocubes
+site_author: Tobias Hölzer
+site_description: >
+  A high-performance library for intelligent loading and caching of remote geospatial raster data, built with xarray, zarr and icechunk.
+
+repo_name: smart-geocubes
+repo_url: https://github.com/relativityhd/smart-geocubes
+edit_uri: edit/main/docs/
+
+nav:
+  - Home: index.md
+  - Getting Started: getting_started.md
+
+theme:
+  name: material
+  language: en
+  custom_dir: docs/overrides
+  icon:
+    repo: fontawesome/brands/github
+    edit: material/pencil
+    view: material/eye
+  palette:
+    # Palette toggle for automatic mode
+    - media: '(prefers-color-scheme)'
+      primary: lime
+      accent: green
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - scheme: default
+      media: '(prefers-color-scheme: light)'
+      primary: lime
+      accent: green
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: slate
+      media: '(prefers-color-scheme: dark)'
+      primary: lime
+      accent: green
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+  font:
+    text: Montserrat
+    code: Roboto Mono
+  features:
+    - navigation.instant
+    - navigation.instant.progress
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.indexes
+    - toc.follow
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - search.share
+    - navigation.footer
+    - content.action.edit
+    - content.code.copy
+    - content.code.annotate
+plugins:
+  - glightbox
+  - mkdocstrings:
+      handlers:
+        python:
+          paths:
+            - 'src'
+          inventories:
+            - https://docs.python.org/3/objects.inv
+            - https://docs.xarray.dev/en/stable/objects.inv
+            - https://numpy.org/doc/stable/objects.inv
+          options:
+            docstring_section_style: list # or "table"
+            docstring_style: 'google'
+            filters: ['!^_']
+            heading_level: 1
+            merge_init_into_class: true
+            parameter_headings: true
+            separate_signature: true
+            show_root_heading: true
+            show_signature_annotations: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            summary: true
+  - api-autonav:
+      modules: ['src/smart_geocubes']
+  - autorefs:
+      resolve_closest: true
+  - privacy:
+      enabled: !ENV [CI, false]
+  - search:
+      lang: en
+  - social:
+      enabled: !ENV [CI, false]
+  - git-revision-date-localized:
+      enabled: !ENV [CI, false]
+      enable_creation_date: true
+      type: date
+  - git-committers:
+      enabled: !ENV [CI, false]
+      repository: relativityhd/smart-geocubes
+      branch: main
+extra:
+  version:
+    provider: mike
+    default: latest
+    alias: true
+  social:
+    - icon: fontawesome/brands/github
+      name: GitHub
+      link: https://github.com/relativityhd/smart-geocubes
+    - icon: fontawesome/brands/python
+      name: PyPI
+      link: https://pypi.org/project/smart-geocubes
+  consent:
+    title: Cookie consent
+    description: >-
+      We use cookies to recognize your repeated visits and preferences, as well
+      as to measure the effectiveness of our documentation and whether users
+      find what they're searching for. With your consent, you're helping us to
+      make our documentation better.
+    cookies:
+      fonts:
+        name: Google Fonts
+        checked: false
+      github:
+        name: GitHub
+        checked: false
+    actions:
+      - accept
+      - manage
+      - reject
+copyright: >
+  Copyright © 2025 Tobias Hölzer -
+  <a href="#__consent">Change cookie settings</a>
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - pymdownx.details
+  - attr_list
+  - admonition
+  - tables
+  - def_list
+  - toc:
+      permalink: true
+      title: Table of Contents