added wizard section to openEO web Editor documentation #233

Pratichhya · 2023-07-28T11:12:08Z

Updated version of #163

Adopted the suggested changes

github-actions · 2023-07-28T11:17:36Z

PR Preview Action v1.4.4
🚀 Deployed preview to https://eu-cdse.github.io/documentation/pr-preview/pr-233/
on branch `gh-pages` at 2023-12-08 14:08 UTC

soxofaan · 2023-08-24T13:54:45Z

That GIF animation is quite large, both in byte size and in pixels (1800px wide). This is quite heavy to load and makes the actual text hard to read because the image will be shrunk in the docs (e.g. to fit in column width).

I'd consider making these kind of screen captures with a non-fullscreen browser window, like the smallest window with that preserves the normal layout of the main elements of the page or feature you want to show.

Pratichhya · 2023-08-24T14:11:38Z

That GIF animation is quite large, both in byte size and in pixels (1800px wide). This is quite heavy to load and makes the actual text hard to read because the image will be shrunk in the docs (e.g. to fit in column width).

I'd consider making these kind of screen captures with a non-fullscreen browser window, like the smallest window with that preserves the normal layout of the main elements of the page or feature you want to show.

Ok sure. I agree with you. Also modification are required to these GIFs since they reflect the old editor version. Thus created a separate issue for it too #261.

Pratichhya · 2023-09-03T12:15:35Z

That GIF animation is quite large, both in byte size and in pixels (1800px wide). This is quite heavy to load and makes the actual text hard to read because the image will be shrunk in the docs (e.g. to fit in column width).

I'd consider making these kind of screen captures with a non-fullscreen browser window, like the smallest window with that preserves the normal layout of the main elements of the page or feature you want to show.

I have updated all the gifs and tried to maintaining the size of the file to less than 1MB. Nevertheless, I am not sure if the quality of available GIFs is good to be integrated or not.

Pratichhya · 2023-10-02T08:07:18Z

To maintain a clean and clear view, I changed all the GIFs to images instead. Please let me know if this view is better or should change to GIF itself instead.

soxofaan · 2023-10-03T14:08:43Z

Yeah, it's probably better to stick to static images where possible, as animated gifs are harder to review/maintain.

Small remark tough: I notice that a lot of these new images are in the root of the _images folder and have very short generic names like "save.png", "bbox.png", "bands.png", while they are specific to the webeditor. I think it is more future-proof to give a more specific name, or put them in a subfolder.

Pratichhya · 2023-10-04T07:38:42Z

Yeah, it's probably better to stick to static images where possible, as animated gifs are harder to review/maintain.

Small remark tough: I notice that a lot of these new images are in the root of the _images folder and have very short generic names like "save.png", "bbox.png", "bands.png", while they are specific to the webeditor. I think it is more future-proof to give a more specific name, or put them in a subfolder.

Yes, I agree. Thank you for suggestion, it makes sense. However, in this PR, I rearranged only the images of the web editor section , but I will create a new PR to rearrange images.

soxofaan · 2023-11-10T15:04:18Z

Applications/WebEditor.qmd

@@ -54,7 +54,7 @@ Upon initial access to the provided link, users are presented with the following

    As previously mentioned, it is necessary to log in to interact with the server. A new window will appear when attempting to log in, as demonstrated below. While other options are sometimes available, the recommended authentication choice is the "Copernicus Data Space Ecosystem". For further information regarding various authentication methods or to seek assistance, you can always click on the "help" option at the top or contact us.

-    <centre><img src="_images/login.PNG"  width="80%" height="60%"></centre>
+    <centre><img src="_images/webeditor/editor_login.PNG"  width="80%" height="60%"></centre>


note that this image is pretty outdated, it still contains "EGI" and "internal" options, which are dropped now

updated the image

soxofaan · 2023-11-10T15:08:52Z

Applications/WebEditor.qmd

@@ -63,48 +63,96 @@ Based on their applications user can build their model by simple drag and drop m

 1. Load Collection 

-    In order to load the required collection make sure it is available by searching in the sidebar. Once you find your collection you can simply drag and drop it for carrying out further actions. In the following clip, you can observe the sequential actions are taken to accomplish the following tasks: choosing a collection of interest, defining the spatial and temporal boundaries, and filtering the necessary bands for subsequent processing. Specifically, for calculating the NDVI, the Red band (B04) and Near-Infrared (NIR) band (B08) have been selected.
+    a. To start a task within the openEO web editor, your first step involves ensuring you have the necessary dataset for the analysis. Thus, you must ensure the required dataset exists within the openEO database. You can do this by exploring/searching the list of available datasets from the sidebar of the interface.


use "collection" iso "dataset". Also "ensure" sounds a bit weird here

soxofaan · 2023-11-10T15:10:03Z

Applications/WebEditor.qmd

-    In order to load the required collection make sure it is available by searching in the sidebar. Once you find your collection you can simply drag and drop it for carrying out further actions. In the following clip, you can observe the sequential actions are taken to accomplish the following tasks: choosing a collection of interest, defining the spatial and temporal boundaries, and filtering the necessary bands for subsequent processing. Specifically, for calculating the NDVI, the Red band (B04) and Near-Infrared (NIR) band (B08) have been selected.
+    a. To start a task within the openEO web editor, your first step involves ensuring you have the necessary dataset for the analysis. Thus, you must ensure the required dataset exists within the openEO database. You can do this by exploring/searching the list of available datasets from the sidebar of the interface.
+
+    b. In our example, we want to calculate the Normalized Difference Vegetation Index (NDVI), so the Sentinel 2 L2A collection will be used. Once you find this collection, the next step is to drag and drop it into the Process Editor for further operations.


I don't understand the difference between step a and b here, both are about finding the desired collection.

combined and modified all the steps

soxofaan · 2023-11-10T15:14:46Z

Applications/WebEditor.qmd

+    ![](_images/webeditor/drag_collection.png)
+
+
+    Now, once you load collection, there are several parameters you need to specify, including the area of interest, the temporal extent, and the selection of bands. When you click on the collection, a window pops up, where you can define the necessary parameters for subsequent processing. 


When you click on the collection, a window pops up,

I think this should be clicking on any load_collection parameter, or clicking the "edit" icon in top right corner

updated the sentence

soxofaan · 2023-11-10T15:16:25Z

Applications/WebEditor.qmd


+    d. Another parameter is Temporal extent, that imits the data to load from the collection to the specified  temporal interval.


Suggested change

d. Another parameter is Temporal extent, that imits the data to load from the collection to the specified temporal interval.

d. Another parameter is temporal extent to limit the data to load to the specified time window.

soxofaan · 2023-11-10T15:20:28Z

Applications/WebEditor.qmd


 2. Apply Processes

-    Eventually, the next step involves implementing essential processes, ranging from straightforward operations like adding bands to more complex tasks such as importing or defining user-defined functions (UDFs). In the following clip, a reduce_dimension() process is employed to eliminate the temporal dimension by selecting the maximum value. The same process is utilised to reduce the band dimension after executing a series of addition, subtraction, and division operations necessary for the NDVI calculation.
+    Eventually, the next step involves implementing essential processes, ranging from straightforward operations like adding bands to more complex tasks such as importing or defining user-defined functions (UDFs). 


Suggested change

Eventually, the next step involves implementing essential processes, ranging from straightforward operations like adding bands to more complex tasks such as importing or defining user-defined functions (UDFs).

The next step involves applying essential openEO processes, ranging from straightforward mathematical operations to more complex tasks such spatial or temporal aggregations.

soxofaan · 2023-11-10T15:23:31Z

Applications/WebEditor.qmd

-    Eventually, the next step involves implementing essential processes, ranging from straightforward operations like adding bands to more complex tasks such as importing or defining user-defined functions (UDFs). In the following clip, a reduce_dimension() process is employed to eliminate the temporal dimension by selecting the maximum value. The same process is utilised to reduce the band dimension after executing a series of addition, subtraction, and division operations necessary for the NDVI calculation.
+    Eventually, the next step involves implementing essential processes, ranging from straightforward operations like adding bands to more complex tasks such as importing or defining user-defined functions (UDFs). 
+
+    In this task, we're using a specific process called `reduce_dimension` as a key part of the operation. This process helps us simplify our collection: first, we use it to reduce temporal dimension and second, to deal with the various bands.


Suggested change

In this task, we're using a specific process called `reduce_dimension` as a key part of the operation. This process helps us simplify our collection: first, we use it to reduce temporal dimension and second, to deal with the various bands.

In this task, we'll using a specific openEO process called `reduce_dimension` two times to simplify our data cube. First to reduce the temporal dimension, and second to deal with the various bands.

soxofaan · 2023-11-10T15:26:37Z

Applications/WebEditor.qmd

+
+    ![](_images/webeditor/reduce_dimension.png)
+
+    In the initial process, the `reduce_dimension` algorithm eliminates the temporal dimension by selecting the maximum value using the max function.


Note that, scientifically speaking, it is pretty weird to first do a temporal reduction of your raw sensor values and do NDVI calculation afterwards because you will be calculating the NDVI from red and nir values that might be unrelated. I think you first should do NDVI calculation and then taking the temporal max.

updated the method and noted

soxofaan · 2023-11-10T15:28:30Z

Applications/WebEditor.qmd

+
+    ![](_images/webeditor/save_process.png)
+
+    Since our application involves simple NDVI calculation, we want to save it as a GeoTiff. 


Suggested change

Since our application involves simple NDVI calculation, we want to save it as a GeoTiff.

Since our workflow eliminated the temporal dimension, we can keep things simple and just save the result as a GeoTiff.

jdries · 2023-11-26T19:07:45Z

Applications/WebEditor.qmd

+
+    Now, once you load collection, there are several parameters you need to specify, including the area of interest, the temporal extent, and the selection of bands. When you click on the collection, a window pops up, where you can define the necessary parameters for subsequent processing. 
+
+    c. To specify the area of interest, you can choose between generating a bounding box or importing your spatial extent by dragging and dropping GeoJSON or KML files onto the map view. Here, we've provided an example involving a bounding box. There is also an option to "No filter", that will include all the data in the datacube.


No bounding box filter is generally a bad idea for novice users (the ones that use a wizard). Instead we should point out that the user should start with a sufficiently small boundingbox with respect to the resolution of the data.

updated the sentence

jdries · 2023-11-26T19:08:37Z

Applications/WebEditor.qmd


+    d. Another parameter is Temporal extent, that imits the data to load from the collection to the specified  temporal interval.


here as well, same as bbox: please encourage the user to start small, like a 10 or 15 day interval.

updated the sentence

Pratichhya · 2023-12-22T09:48:45Z

Assuming that the updated changes are good to go, please allow me to merge this PR to prevent conflict when rearranging the file for introductory page visualization modification.

Please, additional suggestions; please kindly reopen the connected issue.

Pratichhya added 2 commits July 28, 2023 12:46

migrated the previous wizard changes

1b31e7c

Adopted suggested changes

45a913d

Pratichhya mentioned this pull request Jul 28, 2023

added wizard section #163

Closed

Pratichhya linked an issue Aug 8, 2023 that may be closed by this pull request

Include wizard feature in openEO documentation #175

Closed

Pratichhya requested a review from soxofaan August 18, 2023 14:00

Pratichhya linked an issue Sep 1, 2023 that may be closed by this pull request

old gif in web-editor #261

Closed

included simpler clips

5f131bc

Pratichhya changed the title ~~added wizard section to openEo web Editor documentation~~ added wizard section to openEO web Editor documentation Sep 3, 2023

removed large gif file

9f7e63a

Pratichhya added 2 commits September 20, 2023 18:04

Merge branch 'publish' into openEO_webeditor_v2

f542aa3

changed gtif to images

5bd9809

updated image name and locations

15922c1

Pratichhya mentioned this pull request Oct 27, 2023

Rearrange images #343

Open

soxofaan reviewed Nov 10, 2023

View reviewed changes

jdries reviewed Nov 26, 2023

View reviewed changes

Pratichhya added 2 commits December 8, 2023 14:37

addressed updated comments

e62bd76

spacing

2ec1c58

Pratichhya merged commit ecdec11 into publish Dec 22, 2023
1 check passed

Pratichhya deleted the openEO_webeditor_v2 branch January 15, 2024 09:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added wizard section to openEO web Editor documentation #233

added wizard section to openEO web Editor documentation #233

Pratichhya commented Jul 28, 2023

github-actions bot commented Jul 28, 2023 •

edited

Loading

soxofaan commented Aug 24, 2023

Pratichhya commented Aug 24, 2023

Pratichhya commented Sep 3, 2023

Pratichhya commented Oct 2, 2023

soxofaan commented Oct 3, 2023

Pratichhya commented Oct 4, 2023

soxofaan Nov 10, 2023

Pratichhya Dec 8, 2023

soxofaan Nov 10, 2023

Pratichhya Dec 8, 2023

soxofaan Nov 10, 2023

Pratichhya Dec 8, 2023

soxofaan Nov 10, 2023

Pratichhya Dec 8, 2023

soxofaan Nov 10, 2023

soxofaan Nov 10, 2023

soxofaan Nov 10, 2023

soxofaan Nov 10, 2023

Pratichhya Dec 8, 2023

soxofaan Nov 10, 2023

jdries Nov 26, 2023

Pratichhya Dec 8, 2023

jdries Nov 26, 2023

Pratichhya Dec 8, 2023

Pratichhya commented Dec 22, 2023

		![](_images/webeditor/drag_collection.png)


		Now, once you load collection, there are several parameters you need to specify, including the area of interest, the temporal extent, and the selection of bands. When you click on the collection, a window pops up, where you can define the necessary parameters for subsequent processing.


		d. Another parameter is Temporal extent, that imits the data to load from the collection to the specified temporal interval.

	d. Another parameter is Temporal extent, that imits the data to load from the collection to the specified temporal interval.
	d. Another parameter is temporal extent to limit the data to load to the specified time window.

	Eventually, the next step involves implementing essential processes, ranging from straightforward operations like adding bands to more complex tasks such as importing or defining user-defined functions (UDFs).
	The next step involves applying essential openEO processes, ranging from straightforward mathematical operations to more complex tasks such spatial or temporal aggregations.

	In this task, we're using a specific process called `reduce_dimension` as a key part of the operation. This process helps us simplify our collection: first, we use it to reduce temporal dimension and second, to deal with the various bands.
	In this task, we'll using a specific openEO process called `reduce_dimension` two times to simplify our data cube. First to reduce the temporal dimension, and second to deal with the various bands.


		![](_images/webeditor/reduce_dimension.png)

		In the initial process, the `reduce_dimension` algorithm eliminates the temporal dimension by selecting the maximum value using the max function.


		![](_images/webeditor/save_process.png)

		Since our application involves simple NDVI calculation, we want to save it as a GeoTiff.

	Since our application involves simple NDVI calculation, we want to save it as a GeoTiff.
	Since our workflow eliminated the temporal dimension, we can keep things simple and just save the result as a GeoTiff.


		Now, once you load collection, there are several parameters you need to specify, including the area of interest, the temporal extent, and the selection of bands. When you click on the collection, a window pops up, where you can define the necessary parameters for subsequent processing.

		c. To specify the area of interest, you can choose between generating a bounding box or importing your spatial extent by dragging and dropping GeoJSON or KML files onto the map view. Here, we've provided an example involving a bounding box. There is also an option to "No filter", that will include all the data in the datacube.

added wizard section to openEO web Editor documentation #233

added wizard section to openEO web Editor documentation #233

Conversation

Pratichhya commented Jul 28, 2023

github-actions bot commented Jul 28, 2023 • edited Loading

soxofaan commented Aug 24, 2023

Pratichhya commented Aug 24, 2023

Pratichhya commented Sep 3, 2023

Pratichhya commented Oct 2, 2023

soxofaan commented Oct 3, 2023

Pratichhya commented Oct 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pratichhya commented Dec 22, 2023

github-actions bot commented Jul 28, 2023 •

edited

Loading