Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: sync sentinel1_stats udp description with the markdown docs #54

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: sync sentinel1_stats udp description with the markdown docs #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99495a2
fix: sync sentinel1_stats udp description with the markdown docs
rahmandawibowo-vito Nov 8, 2024
c50217e
fix: update README.md of sentinel1 stats
rahmandawibowo-vito Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...thm_catalog/sentinel1_stats/sentinel1.png → ...talog/sentinel1_stats_files/sentinel1.png
View file
Open in desktop
File renamed without changes
0 ...nel1_stats/sentinel1_stats_description.md → ...tats_files/sentinel1_stats_description.md
View file
Open in desktop
File renamed without changes.
17 changes: 14 additions & 3 deletions openeo_udp/sentinel1_stats/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
Calculate S1 SAR stats (min, max, mean, sd, q10, q50, q90).
# Description

This service can cost an approximate of 3-5 credits per sq km.
This cost is based on resource consumption only and added-value cost has not been included.
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@soxofaan soxofaan Nov 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

The 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.



# Examples

Below we show the derived minimum and maximum values for both VV and VH bands, calculated for the 20x20 km2 area of interest.

![s1_stats](sentinel1.png)
2 changes: 1 addition & 1 deletion openeo_udp/sentinel1_stats/sentinel1_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@
},
"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![s1_stats](./sentinel1.png)",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note that the original text comes from https://github.com/ESA-APEx/apex_algorithms/blob/b2f7af26a231d88d47cbf09ce61be4088cb58ef3/openeo_udp/sentinel1_stats/README.md
through

apex_algorithms/openeo_udp/sentinel1_stats/generate.py

Line 58 in b2f7af2

description=(Path(__file__).parent / "README.md").read_text(),

So it should be updated too

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the README.md on the last commit c50217e

"parameters": [
{
"name": "spatial_extent",
Expand Down