Merge branch 'EP4053-compute-indices'

Author: soxofaan

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add `options` argument to `DataCube.atmospheric_correction` ([Open-EO/openeo-python-driver#91](https://github.com/Open-EO/openeo-python-driver/issues/91))
 - Add `atmospheric_correction_options` and `cloud_detection_options` arguments to `DataCube.ard_surface_reflectance` ([Open-EO/openeo-python-driver#91](https://github.com/Open-EO/openeo-python-driver/issues/91))
 - UDP storing: add support for "returns", "categories", "examples" and "links" properties ([#242](https://github.com/Open-EO/openeo-python-client/issues/242))
+- Add `openeo.extra.spectral_indices`: experimental API to easily compute spectral indices (vegetation, water, urban, ...)
+  on a `DataCube`, using the index definitions from [Awesome Spectral Indices](https://awesome-ee-spectral-indices.readthedocs.io/en/latest/)
 
 
 ### Changed

MANIFEST.in

@@ -0,0 +1,3 @@
+include openeo/extra/spectral_indices/resources/*.json
+include openeo/extra/spectral_indices/resources/*/*.json
+include openeo/extra/spectral_indices/resources/*/LICENSE*

docs/cookbook/index.rst

@@ -8,3 +8,4 @@ OpenEO CookBook
    ard
    sampling
    udp_sharing
+   spectral_indices

docs/cookbook/spectral_indices.rst

@@ -0,0 +1,9 @@
+====================================
+Spectral Indices
+====================================
+
+.. warning::
+    This is a new experimental API, subject to change.
+
+.. automodule:: openeo.extra.spectral_indices
+    :members: list_indices, compute_and_rescale_indices, append_and_rescale_indices, compute_indices, append_indices, compute_index, append_index

openeo/extra/__init__.py

@@ -0,0 +1,13 @@
+"""
+Easily calculate spectral indices (vegetation, water, urban etc.).
+
+Supports the indices defined in the
+`Awesome Spectral Indices <https://awesome-ee-spectral-indices.readthedocs.io/>`_ project
+by `David Montero Loaiza <https://github.com/davemlz>`_.
+
+
+.. versionadded:: 0.9.1
+
+"""
+
+from openeo.extra.spectral_indices.spectral_indices import *

openeo/extra/spectral_indices/__init__.py

@@ -0,0 +1,8 @@
+
+Spectral Index specification files, derived from and based on the 
+[Awesome Spectral Indices](https://awesome-ee-spectral-indices.readthedocs.io/) project
+by [David Montero Loaiza](https://github.com/davemlz)
+
+- `awesome-spectral-indices/spectral-indices-dict.json` comes straight from https://github.com/davemlz/awesome-spectral-indices/blob/main/output/spectral-indices-dict.json
+- `extra-indixes-dict.json` is a set of additional indices not (yet) provided by Awesome Spectral Indices
+

openeo/extra/spectral_indices/resources/README.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 David Montero Loaiza
+
+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.