Merge branch 'draft' into ml

Open-EO · Aug 23, 2023 · b162040 · b162040
2 parents d275d78 + 7a29378
commit b162040
Show file tree

Hide file tree

Showing 21 changed files with 293 additions and 150 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -5,7 +5,6 @@ on:
   push:
     branches:
       - draft
-      - draft-2.0
       - master
 jobs:
   deploy:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,9 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased / Draft
 
+## [2.0.0-rc.1] - 2023-05-25
+
 ### Added
 
 - New processes in proposal state:
+    - `date_between`
     - `date_difference`
     - `filter_vector`
     - `flatten_dimensions`
@@ -24,7 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - `vector_reproject`
     - `vector_to_random_points`
     - `vector_to_regular_points`
-- `add_dimension`: Added new dimension type `geometries`. [#68](https://github.com/Open-EO/openeo-processes/issues/68)
+- `add_dimension`: Added new dimension type `geometry`. [#68](https://github.com/Open-EO/openeo-processes/issues/68)
 
 ### Changed
 
@@ -44,9 +47,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - Allow `null` as default value for units.
     - Input and Output for the `process` can either be data cubes or arrays (if one-dimensional). [#387](https://github.com/Open-EO/openeo-processes/issues/387)
 - `run_udf`: Allow all data types instead of just objects in the `context` parameter. [#376](https://github.com/Open-EO/openeo-processes/issues/376)
-- `load_collection` and `load_result`:
+- `load_collection` and `load_result`/`load_stac`:
     - Require at least one band if not set to `null`. [#372](https://github.com/Open-EO/openeo-processes/issues/372)
     - Added a `NoDataAvailable` exception
+- `aggregate_temporal`, `filter_temporal`, `load_collection` and `load_result`/`load_stac`:
+    - The temporal intervals must always be non-empty, i.e. the second instance in time must be after the first instance in time. [#331](https://github.com/Open-EO/openeo-processes/issues/331)
+    - `24` as the hour is not allowed anymore. [#331](https://github.com/Open-EO/openeo-processes/issues/331)
 - `inspect`: The parameter `message` has been moved to be the second argument. [#369](https://github.com/Open-EO/openeo-processes/issues/369)
 - `mask` and `merge_cubes`: The spatial dimensions `x` and `y` can now be resampled implicitly instead of throwing an error. [#402](https://github.com/Open-EO/openeo-processes/issues/402)
 - `save_result`: Added a more concrete `DataCubeEmpty` exception.
@@ -58,6 +64,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated the processes based on the subtypes `raster-cube` or `vector-cube` to work with the subtype `datacube` instead. [#68](https://github.com/Open-EO/openeo-processes/issues/68)
 - `sort` and `order`: The ordering of ties is not defined anymore. [#409](https://github.com/Open-EO/openeo-processes/issues/409)
 - `quantiles`: Parameter `probabilities` provided as array must be in ascending order. [#297](https://github.com/Open-EO/openeo-processes/pull/297)
+- `fit_curve` and `predict_curve`: Heavily modified specifications. `fit_curve` works on arrays instead of data cubes, `predict_curve` doesn't support gap filling anymore, clarify no-data handling, ... [#425](https://github.com/Open-EO/openeo-processes/issues/425)
+- `climatological_normal`: The `climatology_period` parameter accepts an array of integers instead of strings. [#331](https://github.com/Open-EO/openeo-processes/issues/331)
 
 ### Deprecated
 
@@ -66,7 +74,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 
 - The `examples` folder has been migrated to the [openEO Community Examples](https://github.com/Open-EO/openeo-community-examples/tree/main/processes) repository.
-- `between`: Support for temporal comparison.
+- `between`: Support for temporal comparison. Use `date_between` instead. [#331](https://github.com/Open-EO/openeo-processes/issues/331)
 - Deprecated `GeometryCollections` are not supported any longer. [#389](https://github.com/Open-EO/openeo-processes/issues/389)
 - Deprecated PROJ definitions for the CRS are not supported any longer.
 - `load_result`:
@@ -76,6 +84,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The comparison processes `eq`, `neq`, `lt`, `lte`, `gt`, `gte` and `array_contains`:
     - Removed support for temporal comparison. Instead explicitly use `date_difference`.
     - Removed support for the input data types array and object. [#208](https://github.com/Open-EO/openeo-processes/issues/208)
+- `sort` and `order`: Removed support for time-only values. [#331](https://github.com/Open-EO/openeo-processes/issues/331)
 
 ### Fixed
 
@@ -361,7 +370,8 @@ First version which is separated from the openEO API. Complete rework of all pro
 Older versions of the processes were released as part of the openEO API, see the corresponding changelog for more information.
 
 
-[Unreleased]: <https://github.com/Open-EO/openeo-processes/compare/1.2.0...HEAD>
+[Unreleased]: <https://github.com/Open-EO/openeo-processes/compare/2.0.0-rc.1...HEAD>
+[2.0.0-rc.1]: <https://github.com/Open-EO/openeo-processes/compare/1.2.0...2.0.0-rc.1>
 [1.2.0]: <https://github.com/Open-EO/openeo-processes/compare/1.1.0...1.2.0>
 [1.1.0]: <https://github.com/Open-EO/openeo-processes/compare/1.0.0...1.1.0>
 [1.0.0]: <https://github.com/Open-EO/openeo-processes/compare/1.0.0-rc.1...1.0.0>

diff --git a/README.md b/README.md
@@ -8,12 +8,13 @@ openEO develops interoperable processes for big Earth observation cloud processi
 
 The [master branch](https://github.com/Open-EO/openeo-processes/tree/master) is the 'stable' version of the openEO processes specification. An exception is the [`proposals`](proposals/) folder, which provides experimental new processes currently under discussion. They may still change, but everyone is encouraged to implement them and give feedback.
 
-The latest release is version **1.2.0**. The [draft branch](https://github.com/Open-EO/openeo-processes/tree/draft) is where active development takes place. PRs should be made against the draft branch.
+The latest release is version **2.0.0-rc.1**. The [draft branch](https://github.com/Open-EO/openeo-processes/tree/draft) is where active development takes place. PRs should be made against the draft branch.
 
 | Version / Branch                                             | Status                    | openEO API versions |
 | ------------------------------------------------------------ | ------------------------- | ------------------- |
 | [unreleased / draft](https://processes.openeo.org/draft)     | in development            | 1.x.x               |
-| [**1.2.0** / master](https://processes.openeo.org/1.2.0/)    | **latest stable version** | 1.x.x               |
+| [**2.0.0 RC1** / master](https://processes.openeo.org/2.0.0-rc.1/) | **upcoming version (RC)** | 1.x.x         |
+| [1.2.0](https://processes.openeo.org/1.2.0/)                 | **latest stable version** | 1.x.x               |
 | [1.1.0](https://processes.openeo.org/1.1.0/)                 | legacy version            | 1.x.x               |
 | [1.0.0](https://processes.openeo.org/1.0.0/)                 | legacy version            | 1.x.x               |
 | [1.0.0 RC1](https://processes.openeo.org/1.0.0-rc.1/)        | legacy version            | 1.x.x               |

diff --git a/aggregate_temporal.json b/aggregate_temporal.json
@@ -22,39 +22,36 @@
         },
         {
             "name": "intervals",
-            "description": "Left-closed temporal intervals, which are allowed to overlap. Each temporal interval in the array has exactly two elements:\n\n1. The first element is the start of the temporal interval. The specified instance in time is **included** in the interval.\n2. The second element is the end of the temporal interval. The specified instance in time is **excluded** from the interval.\n\nThe specified temporal strings follow [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html). Although [RFC 3339 prohibits the hour to be '24'](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.7), **this process allows the value '24' for the hour** of an end time in order to make it possible that left-closed time intervals can fully cover the day.",
+            "description": "Left-closed temporal intervals, which are allowed to overlap. Each temporal interval in the array has exactly two elements:\n\n1. The first element is the start of the temporal interval. The specified time instant is **included** in the interval.\n2. The second element is the end of the temporal interval. The specified time instant is **excluded** from the interval.\n\nThe second element must always be greater/later than the first element, except when using time without date. Otherwise, a `TemporalExtentEmpty` exception is thrown.",
             "schema": {
                 "type": "array",
                 "subtype": "temporal-intervals",
                 "minItems": 1,
                 "items": {
                     "type": "array",
                     "subtype": "temporal-interval",
+                    "uniqueItems": true,
                     "minItems": 2,
                     "maxItems": 2,
                     "items": {
                         "anyOf": [
                             {
                                 "type": "string",
                                 "format": "date-time",
-                                "subtype": "date-time"
+                                "subtype": "date-time",
+                                "description": "Date and time with a time zone."
                             },
                             {
                                 "type": "string",
                                 "format": "date",
-                                "subtype": "date"
+                                "subtype": "date",
+                                "description": "Date only, formatted as `YYYY-MM-DD`. The time zone is UTC. Missing time components are all 0."
                             },
                             {
                                 "type": "string",
-                                "format": "time",
-                                "subtype": "time"
-                            },
-                            {
-                                "type": "string",
-                                "subtype": "year",
-                                "minLength": 4,
-                                "maxLength": 4,
-                                "pattern": "^\\d{4}$"
+                                "subtype": "time",
+                                "pattern": "^\\d{2}:\\d{2}:\\d{2}$",
+                                "description": "Time only, formatted as `HH:MM:SS`. The time zone is UTC."
                             },
                             {
                                 "type": "null"
@@ -79,12 +76,12 @@
                     ],
                     [
                         [
-                            "00:00:00Z",
-                            "12:00:00Z"
+                            "06:00:00",
+                            "18:00:00"
                         ],
                         [
-                            "12:00:00Z",
-                            "24:00:00Z"
+                            "18:00:00",
+                            "06:00:00"
                         ]
                     ]
                 ]
@@ -235,13 +232,21 @@
         },
         "DistinctDimensionLabelsRequired": {
             "message": "The dimension labels have duplicate values. Distinct labels must be specified."
+        },
+        "TemporalExtentEmpty": {
+            "message": "At least one of the intervals is empty. The second instant in time must always be greater/later than the first instant."
         }
     },
     "links": [
         {
             "href": "https://openeo.org/documentation/1.0/datacubes.html#aggregate",
             "rel": "about",
             "title": "Aggregation explained in the openEO documentation"
+        },
+        {
+            "href": "https://www.rfc-editor.org/rfc/rfc3339.html",
+            "rel": "about",
+            "title": "RFC3339: Details about formatting temporal strings"
         }
     ]
 }
diff --git a/climatological_normal.json b/climatological_normal.json
@@ -39,20 +39,17 @@
             "description": "The climatology period as a closed temporal interval. The first element of the array is the first year to be fully included in the temporal interval. The second element is the last year to be fully included in the temporal interval.\n\nThe default climatology period is from 1981 until 2010 (both inclusive) right now, but this might be updated over time to what is commonly used in climatology. If you don't want to keep your research to be reproducible, please explicitly specify a period.",
             "schema": {
                 "type": "array",
-                "subtype": "temporal-interval",
+                "uniqueItems": true,
                 "minItems": 2,
                 "maxItems": 2,
                 "items": {
-                    "type": "string",
-                    "subtype": "year",
-                    "minLength": 4,
-                    "maxLength": 4,
-                    "pattern": "^\\d{4}$"
+                    "type": "integer",
+                    "subtype": "year"
                 }
             },
             "default": [
-                "1981",
-                "2010"
+                1981,
+                2010
             ],
             "optional": true
         }

diff --git a/filter_bbox.json b/filter_bbox.json
@@ -1,7 +1,7 @@
 {
     "id": "filter_bbox",
     "summary": "Spatial filter using a bounding box",
-    "description": "Limits the data cube to the specified bounding box.\n\n* For raster data cubes, the filter retains a pixel in the data cube if the point at the pixel center intersects with the bounding box (as defined in the Simple Features standard by the OGC). Alternatively, ``filter_spatial()`` can be used to filter by geometry.\n* For vector data cubes, the filter retains the geometry in the data cube if the geometry is fully within the bounding box (as defined in the Simple Features standard by the OGC). All geometries that were empty or get empty will be removed from the data cube. Alternatively, ``filter_vector()`` can be used to filter by geometry.",
+    "description": "Limits the data cube to the specified bounding box.\n\n* For raster data cubes, the filter retains a pixel in the data cube if the point at the pixel center intersects with the bounding box (as defined in the Simple Features standard by the OGC). Alternatively, ``filter_spatial()`` can be used to filter by geometry.\n* For vector data cubes, the filter retains the geometry in the data cube if the geometry is fully within the bounding box (as defined in the Simple Features standard by the OGC). All geometries that were empty or not contained fully within the bounding box will be removed from the data cube.\n\nAlternatively, ``filter_vector()`` can be used to filter by geometry.",
     "categories": [
         "cubes",
         "filter"

diff --git a/filter_temporal.json b/filter_temporal.json
@@ -22,7 +22,7 @@
         },
         {
             "name": "extent",
-            "description": "Left-closed temporal interval, i.e. an array with exactly two elements:\n\n1. The first element is the start of the temporal interval. The specified instance in time is **included** in the interval.\n2. The second element is the end of the temporal interval. The specified instance in time is **excluded** from the interval.\n\nThe specified temporal strings follow [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html). Also supports open intervals by setting one of the boundaries to `null`, but never both.",
+            "description": "Left-closed temporal interval, i.e. an array with exactly two elements:\n\n1. The first element is the start of the temporal interval. The specified time instant is **included** in the interval.\n2. The second element is the end of the temporal interval. The specified time instant is **excluded** from the interval.\n\nThe second element must always be greater/later than the first element. Otherwise, a `TemporalExtentEmpty` exception is thrown.\n\nAlso supports unbounded intervals by setting one of the boundaries to `null`, but never both.",
             "schema": {
                 "type": "array",
                 "subtype": "temporal-interval",
@@ -33,19 +33,14 @@
                         {
                             "type": "string",
                             "format": "date-time",
-                            "subtype": "date-time"
+                            "subtype": "date-time",
+                            "description": "Date and time with a time zone."
                         },
                         {
                             "type": "string",
                             "format": "date",
-                            "subtype": "date"
-                        },
-                        {
-                            "type": "string",
-                            "subtype": "year",
-                            "minLength": 4,
-                            "maxLength": 4,
-                            "pattern": "^\\d{4}$"
+                            "subtype": "date",
+                            "description": "Date only, formatted as `YYYY-MM-DD`. The time zone is UTC. Missing time components are all 0."
                         },
                         {
                             "type": "null"
@@ -92,13 +87,21 @@
     "exceptions": {
         "DimensionNotAvailable": {
             "message": "A dimension with the specified name does not exist."
+        },
+        "TemporalExtentEmpty": {
+            "message": "The temporal extent is empty. The second instant in time must always be greater/later than the first instant in time."
         }
     },
     "links": [
         {
             "href": "https://openeo.org/documentation/1.0/datacubes.html#filter",
             "rel": "about",
             "title": "Filters explained in the openEO documentation"
+        },
+        {
+            "href": "https://www.rfc-editor.org/rfc/rfc3339.html",
+            "rel": "about",
+            "title": "RFC3339: Details about formatting temporal strings"
         }
     ]
 }