Skip to content

Commit aaf56ef

Browse files
authored
Merge branch 'draft' into workspace-paths
2 parents 6ce4cf9 + 7974ff2 commit aaf56ef

File tree

109 files changed

+1148
-1113
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+1148
-1113
lines changed

CHANGELOG.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,53 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99
### Added
1010

1111
- Implementation guide for implementing OGC API - Processes in openEO
12-
- `export_collection`
13-
- `export_workspace`
14-
- `run_ogcapi`
15-
- `run_ogcapi_externally`
16-
- `stac_modify`
12+
- `date_difference`: Allow `week` as a unit [#506](https://github.com/Open-EO/openeo-processes/issues/506)
13+
- `export_collection`: New process
14+
- `export_workspace`: New process
15+
- `run_ogcapi`: New process
16+
- `run_ogcapi_externally`: New process
17+
- `stac_modify`: New process
18+
- `text_find`: New process
1719

1820
### Changed
1921

20-
- `clip`: Throw an exception if min > max [#472](https://github.com/Open-EO/openeo-processes/issues/472)
21-
- `save_results`: Returns the STAC resource instead of boolean `true` [API#376](https://github.com/Open-EO/openeo-api/issues/376)
22+
- Processes that have been marked as stable: `apply_polygon`, `date_between`, `date_shift`, `filter_labels`, `inspect`
23+
- Clarified for various mathematical functions the defined input and output ranges.
24+
Mention that `NaN` is returned outside of the defined input range where possible.
25+
- Clarified for several comparison processes how `NaN` values have to be handled.
26+
- Clarified for various processes the handling of no-data values and `null`, see also the [implementation guide](meta/implementation.md#no-data-value). [#480](https://github.com/Open-EO/openeo-processes/issues/480)
27+
- Added a [section about character encodings to the implementation guide](meta/implementation.md#character-encoding).
28+
Removed any character encoding related wording from the process specifications itself.
2229
- Added a uniqueness contraint to various array-typed parameters (e.g. lists of dimension names or labels)
2330
- `apply_polygon`: Renamed `polygons` parameter to `geometries` for better alignment with other geometry handling processes. [#511](https://github.com/Open-EO/openeo-processes/issues/511)
31+
- `clip`: Throw an exception if min > max [#472](https://github.com/Open-EO/openeo-processes/issues/472)
32+
- `save_results`: Returns the STAC resource instead of boolean `true` [API#376](https://github.com/Open-EO/openeo-api/issues/376)
2433

2534
### Fixed
2635

2736
- Clarified for various mathematical functions the defined input and output ranges. Mention that `NaN` is returned outside of the defined input range where possible.
37+
- Clarified for various processes the handling of no-data values and null, see also the [implementation guide](meta/implementation.md). [#480](https://github.com/Open-EO/openeo-processes/issues/480)
38+
- `add_dimension`: Clearly define behaviour for adding spatial dimensions
2839
- `apply_polygon`: Replaced outdated usage of `raster-cube` subtype with `datacube` and dimensions. [#524](https://github.com/Open-EO/openeo-processes/issues/524)
40+
- `aggregate_spatial` and `load_geojson`: Dimensions must by of type `geometry`, not `geometries`
41+
- `aggregate_spatial`: Clarified that the output geometries are unchanged compared to the input geometries. [#499](https://github.com/Open-EO/openeo-processes/issues/499)
2942
- `aggregate_temporal` and `aggregate_temporal_period`: Clarified that the process throws a `DimensionNotAvailable` exception when no temporal dimension exists.
30-
- `aggregate_temporal_period`: Removed unused exception `DistinctDimensionLabelsRequired`
31-
- `aggregate_temporal_period`: Clarified that the definition of weeks follows ISO 8601
43+
- `aggregate_temporal_period`: Removed unused exception `DistinctDimensionLabelsRequired`.
44+
- `aggregate_temporal_period`: Clarified that the definition of weeks follows ISO 8601.
45+
- `apply_polygon`: Replaced outdated usage of `raster-cube` subtype with `datacube` and dimensions. [#524](https://github.com/Open-EO/openeo-processes/issues/524)
46+
- `array_interpolate_linear`: Apply interpolation to NaN and no-data values.
3247
- `cummax`, `cummin`, `cumproduct`, `cumsum`: Clarified the descriptions around the `ignore_nodata` parameter.
3348
- `divide`: Clarified behavior for division by 0
3449
- `between`: Clarify that `null` is passed through.
3550
- `eq` and `neq`: Explicitly set the minimum value for the `delta` parameter.
3651
- `filter_bbox`, `load_collection`, `load_stac`: Clarified that the bounding box is reprojected to the CRS of the spatial data cube dimensions if required.
3752
- `filter_spatial`: Clarified that masking is applied using the given geometries. [#469](https://github.com/Open-EO/openeo-processes/issues/469)
53+
- `load_stac`: Clarify handling of the `properties` parameter in the context of STAC APIs and static catalogs. [#536](https://github.com/Open-EO/openeo-processes/issues/536)
3854
- `load_collection` and `load_stac`: Clarified that scale and offset are not applied automatically when loading the data. [#503](https://github.com/Open-EO/openeo-processes/issues/503)
3955
- `load_uploaded_files` and `run_udf`: Clarify handling of file paths and added `FileNotFound` exception. [#461](https://github.com/Open-EO/openeo-processes/issues/461)
56+
- `mask`: Add missing exception `IncompatibleDataCubes` [#538](https://github.com/Open-EO/openeo-processes/issues/538)
4057
- `mod`: Clarified behavior for y = 0
58+
- `run_udf`: Simplified and clarified the schema for `data` - no functional change.
4159
- `sqrt`: Clarified that NaN is returned for negative numbers.
4260
- Clarify allowed `FeatureCollection` geometries in `load_collection`, `mask_polygon`, `apply_polygon`, and `load_stac` [#527](https://github.com/Open-EO/openeo-processes/issues/527)
4361

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This repository contains a set of files formally describing the openEO Processes
4040
## Process
4141

4242
* All new processes must be added to the [`proposals`](proposals/) folder.
43-
* Processes will only be moved from proposals to the stable process specifications once there are at least two implementations and an example process in the [`openEO community examples`](https://github.com/Open-EO/openeo-community-examples/) showing it in a use case. This doesn't require a PSC vote individually as it's not a breaking change, just an addition.
43+
* Processes will only be moved from proposals to the stable process specifications once there are at least two implementations and an example process in the [`openEO community examples`](https://github.com/Open-EO/openeo-community-examples/) showing it in a use case. Ideally, there are also no open issues. The move doesn't require a PSC vote individually as it's not a breaking change, just an addition.
4444
* The [`proposals`](proposals/) folder allows breaking changes without a PSC vote and without increasing the major version number (i.e. a breaking change in the proposals doesn't require us to make the next version number 2.0.0).
4545
* The proposals are released as experimental processes with the other processes.
4646
* Each release and all breaking changes in the stable process specifications must go through PSC vote.

absolute.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"id": "absolute",
33
"summary": "Absolute value",
4-
"description": "Computes the absolute value of a real number `x`, which is the \"unsigned\" portion of `x` and often denoted as *|x|*.\n\nThe no-data value `null` is passed through and therefore gets propagated.",
4+
"description": "Computes the absolute value of a real number `x`, which is the \"unsigned\" portion of `x` and often denoted as *|x|*.\n\nNo-data values are passed through.",
55
"categories": [
66
"math"
77
],

add.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"id": "add",
33
"summary": "Addition of two numbers",
4-
"description": "Sums up the two numbers `x` and `y` (*`x + y`*) and returns the computed sum.\n\nNo-data values are taken into account so that `null` is returned if any element is such a value.\n\nThe computations follow [IEEE Standard 754](https://ieeexplore.ieee.org/document/8766229) whenever the processing environment supports it.",
4+
"description": "Sums up the two numbers `x` and `y` (*`x + y`*) and returns the computed sum.\n\nNo-data values are taken into account so that the no-data value is returned if any element is such a value.\n\nThe computations follow [IEEE Standard 754](https://ieeexplore.ieee.org/document/8766229) whenever the processing environment supports it.",
55
"categories": [
66
"math"
77
],
@@ -88,4 +88,4 @@
8888
"result": true
8989
}
9090
}
91-
}
91+
}

add_dimension.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
},
3636
{
3737
"name": "type",
38-
"description": "The type of dimension, defaults to `other`.",
38+
"description": "The type of dimension, defaults to `other`.\n\nIf the type is `spatial`, the axis is the first option that does not exist yet from `x`, `y`, and `z`. This refers to the axis of the dimension, not the name of the dimension. Throws a `DimensionExists` exception if dimensions for all axes exist.",
3939
"schema": {
4040
"type": "string",
4141
"enum": [

0 commit comments

Comments
 (0)