fix: sync sentinel1_stats udp description with the markdown docs#54
fix: sync sentinel1_stats udp description with the markdown docs#54rahmandawibowo-vito wants to merge 2 commits intomainfrom
Conversation
| "id": "sentinel1_stats", | ||
| "summary": "Calculate Sentinel-1 SAR stats", | ||
| "description": "Calculate S1 SAR stats (min, max, mean, sd, q10, q50, q90). \n\nThis service can cost an approximate of 3-5 credits per sq km. \nThis cost is based on resource consumption only and added-value cost has not been included.\n", | ||
| "description": "# Description\n\nThis algorithm derives temporal statistics from the Sentinel-1 GRD collection for the selected spatial- and temporal extent of interest. In order to calibrate the SAR backscatter signal, `sigma0-ellipsoid` has been applied within this workflow.\n\n# Performance characteristics\nThe algorithm was evaluated for a spatial extent of 20x20km, for a temporal period of 3 months. The total cost for the performed evaluation was equal to 4 credits, thereby highlighting the efficiency of the underlying algorithm.\n\n# Examples\n\nBelow we show the derived minimum and maximum values for both VV and VH bands, calculated for the 20x20 km2 area of interest.\n\n", |
There was a problem hiding this comment.
note that the original text comes from https://github.com/ESA-APEx/apex_algorithms/blob/b2f7af26a231d88d47cbf09ce61be4088cb58ef3/openeo_udp/sentinel1_stats/README.md
through
So it should be updated too
There was a problem hiding this comment.
I have updated the README.md on the last commit c50217e
| This algorithm derives temporal statistics from the Sentinel-1 GRD collection for the selected spatial- and temporal extent of interest. In order to callibrate the SAR backscatter signal, `sigma0-ellipsoid` has been applied within this workflow. | ||
|
|
||
|
|
||
| # Performance characteristics |
There was a problem hiding this comment.
4 credits is the minimal cost for a UDP, I do not believe it should be part of this PR, but I should increase the size of the benchmarking to get a clearer sight on the 'scaled up' cost
There was a problem hiding this comment.
FYI: while I agree with your comment, we already have this problem on main at algorithm_catalog/sentinel1_stats/sentinel1_stats_description.md
This PR is I guess just about syncing these two files (openeo_udp/sentinel1_stats/README.md and algorithm_catalog/sentinel1_stats/sentinel1_stats_description.md).
We certainly need follow-up tasks:
- improving that "4 credit" cost statement
- find solution for duplication problem -> Description between the openEO UDP and its algorithm docs do not match #61 and Guidelines/conventions for algo/UDP descriptions #62
|
I guess this PR does not apply anymore. Is it still relevant and should it be updated to latest folder structure, or can we just close it as wontfix? |
3 participants
In this PR, I try to sync the UDP description with the one from the markdown file.
The reason is because the description provided on the markdown here https://github.com/ESA-APEx/apex_algorithms/blob/main/algorithm_catalog/sentinel1_stats/sentinel1_stats_description.md seems to be more up-to-date than its UDP description (the UDP description only contain a single paragraph, whereas the markdown file contains performance characteristics & example with images).
I also rename the assets folder to be
algorithm_catalog/sentinel1_stats_files/to standardize with the other UDPs folder naming, and make it easier for the catalogue site to build the reference to the raw image URL.Diff preview: https://www.diffchecker.com/ScJATxym/
Related PR: #36