Documenting how to create a custom odc-stats plugin

.github/workflows/main.yml

@@ -135,10 +135,10 @@ jobs:
           ./tests/integration_test.sh
 
         env:
-          DB_HOSTNAME: postgres
-          DB_USERNAME: opendatacube
-          DB_PASSWORD: opendatacubepassword
-          DB_DATABASE: opendatacube
+          ODC_DEFAULT_DB_HOSTNAME: postgres
+          ODC_DEFAULT_DB_USERNAME: opendatacube
+          ODC_DEFAULT_DB_PASSWORD: opendatacubepassword
+          ODC_DEFAULT_DB_DATABASE: opendatacube
           AWS_NO_SIGN_REQUEST: true
           AWS_DEFAULT_REGION: ap-southeast-2
           AWS_REGION: ap-southeast-2

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
       - id: check-added-large-files
       - id: check-merge-conflict
   - repo: https://github.com/PyCQA/flake8
-    rev: '7.2.0'
+    rev: '7.3.0'
     hooks:
       - id: flake8
   - repo: https://github.com/psf/black

README.md

@@ -334,6 +334,6 @@ The dockerfile for the docker image used in the ochastration, which can be used
 
 ## Integration test
 
-The integration test for the summary products is located under [tests](./tests). Currently the test is performed on all the official summary products published by DEA. The "golden files" to test against are stored on the public accessible [S3 bucket](s3://dea-public-data-dev/stats-golden-files). The "golder files" should be achived but not deleted in the case that we decide to amend or upgrade any product. It will help with tracking the changes that we intend and alerting those that we do not.
+The integration test for the summary products is located under [tests](./tests). Currently the test is performed on all the official summary products published by DEA. The "golden files" to test against are stored on the public accessible [S3 bucket](s3://dea-public-data-dev/stats-golden-files). The "golden files" should be archived but not deleted in the case that we decide to amend or upgrade any product. It will help with tracking the changes that we intend and alerting those that we do not.
 
 The test is meant to be regressive, i.e., the new version of `odc-stats` need to pass the test on the last version of docker image. The new version of docker image needs to pass the test on the current released version of `odc-stats`.

docker/docker-compose.yml

@@ -12,10 +12,10 @@ services:
     build:
       context: .
     environment:
-      - DB_HOSTNAME=postgres
-      - DB_USERNAME=opendatacube
-      - DB_PASSWORD=opendatacubepassword
-      - DB_DATABASE=opendatacube
+      - ODC_DEFAULT_DB_HOSTNAME=postgres
+      - ODC_DEFAULT_DB_USERNAME=opendatacube
+      - ODC_DEFAULT_DB_PASSWORD=opendatacubepassword
+      - ODC_DEFAULT_DB_DATABASE=opendatacube
       - AWS_NO_SIGN_REQUEST=true
       - STAC_API_URL=https://earth-search.aws.element84.com/v0/
       - GDAL_HTTP_MAX_RETRY=5

docker/env.yaml

@@ -48,7 +48,7 @@ dependencies:
   - dask-image
   - deepdiff
   - defusedxml
-  - distributed<2024.11.0
+  - distributed>=2025.4
   - docutils
   - fiona
   - Flask
@@ -120,7 +120,7 @@ dependencies:
   - slicerator
   - snuggs
   - sortedcontainers
-  - SQLAlchemy<2.0
+  - SQLAlchemy
   - structlog
   - tblib
   - text-unidecode

docker/requirements.txt

@@ -1,17 +1,18 @@
 
 --extra-index-url https://packages.dea.ga.gov.au/
-datacube-ows<1.9
-datacube[performance,s3]<1.9
-eodatasets3<1.9
+datacube-ows>=1.9
+datacube[performance,s3]>=1.9.5
+eodatasets3>1.9
 hdstats==0.1.8.post1
-numexpr @ git+https://github.com/pydata/numexpr@a99412e
-odc-algo @ git+https://github.com/opendatacube/odc-algo@adb1856
+numexpr>=2.11
+odc-algo>=1.0.1
 odc-apps-cloud>=0.2.2
 # For testing
 odc-apps-dc-tools>=0.2.12
 odc-cloud>=0.2.5
-odc-dscache>=0.2.3
-odc-stac @ git+https://github.com/opendatacube/odc-stac@69bdf64
+odc-dscache>=1.9
+odc-geo>=0.5.0rc1
+odc-stac>=0.4.0
 
 # odc-stac is in PyPI
 odc-stats[ows]

docs/config_ndvi_ls_median.yaml

@@ -0,0 +1,33 @@
+plugin: odc.stats.plugins.ls_ndvi_median.StatsNDVI # import path to plugin
+plugin_config: #variables for the plugin
+  input_bands: ["nbart_red", "nbart_nir"]
+  output_bands: 'ndvi_median'
+  mask_band: "oa_fmask"
+  contiguity_band: "nbart_contiguity"
+product: #name and key metadata of the product
+  name: ls_ndvi_median
+  short_name: ls_ndvi_median
+  version: 0.0.1
+  product_family: ndvi
+  # -- EO Dataset3 relative section --
+  naming_conventions_values: dea_c3
+  explorer_path: https://explorer.dea.ga.gov.au/
+  classifier: ard
+  maturity: final
+  collection_number: 3
+
+# -parameters for k8s
+max_processing_time: 3600
+job_queue_max_lease: 3600
+renew_safety_margin: 60
+future_poll_interval: 2
+s3_acl: public-read
+
+# Generic product attributes
+cog_opts:
+  zlevel: 9
+  overrides:
+    # If you're making an RGBA image, compress better
+    rgba:
+      compress: JPEG
+      jpeg_quality: 90