You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: eo_service_usage/openeo_usage.md
+27-15Lines changed: 27 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,36 +2,43 @@
2
2
title: openEO based services
3
3
---
4
4
5
-
Context: use of APEx services that expose the [openEO](https://openeo.org/) interface standard, when implemented as openEO processes.
5
+
Context: use of APEx services that expose the [openEO](https://openeo.org/) interface standard, when implemented as openEO
6
+
processes.
6
7
8
+
In general, services can be executed through the tools that are provided by the APEx supported platforms ("processing platforms"
9
+
hereafter).
10
+
For OpenEO based services, this is supported by an online user interface, web editor, Client Libraries (JavaScript, Python,
11
+
R) and API.
7
12
8
-
In general, services can be executed through the tools that are provided by the APEx supported platforms ("processing platforms" hereafter).
9
-
For OpenEO based services, this is supported by an online user interface, web editor, Client Libraries (JavaScript, Python, R) and API.
13
+
There are several ways to discover how a service can be executed. When publishing a service on the
14
+
[APEx Algorithm Catalogue](../guides/algorithm_services_catalogue.qmd), a service provider can choose to provide the
15
+
following information in the service details:
10
16
11
-
There are several ways to discover how a service can be executed. When publishing a service on the APEx Algorithm Services Catalogue, a service provider can choose to provide the following information in the service details:
12
-
13
-
* An executable link which redirects the user to the user interface of the processing platform. If this is the case, an **Access app** button will appear when opening an EOplaza service.
17
+
* An executable link which redirects the user to the user interface of the processing platform. If this is the case, an
18
+
**Access app** button will appear when opening an EOplaza service.
14
19
* Sample code in the service description on how to execute a service.
15
20
16
21
## openEO backends
17
22
18
23
An APEx openEO service is always associated with one or more openEO backends that have been validated to produce the correct
19
24
results. So using one of these backends is the recommended approach. Thanks to openEO interoperability and standardization,
20
-
it may certainly be possible that other backends can run the same service, but do make sure to validate the results in that case.
25
+
it may certainly be possible that other backends can run the same service, but do make sure to validate the results in
26
+
that case.
21
27
22
28
To ensure a smooth experience, backends need to be compliant with [APEx guidelines](../interoperability/algohostingenv.md).
23
29
The currently known list of compliant backends is:
Both are federations, which means that they in fact are backed by multiple openEO instances. This increases the convenience
29
35
for the APEx user, avoiding to interact with a high number of backends.
30
36
31
37
## Online user interface
32
38
33
39
OpenEO provides an online user interface where users can execute services directly in a web browser.
34
-
Through the graphical user interface, users can execute, link, and configure different services. More information on the usage of the online applications is presented in the table below.
40
+
Through the graphical user interface, users can execute, link, and configure different services. More information on the
41
+
usage of the online applications is presented in the table below.
This interface provides a great way to find out how to interact with an openEO backend at the level of the HTTP API.
46
-
Just use the 'developer tools' of your favourite browser and inspect HTTP requests to the backend to find out the various options.
54
+
Just use the 'developer tools' of your favourite browser and inspect HTTP requests to the backend to find out the various
55
+
options.
47
56
:::
48
57
49
58
## Client libraries
50
59
51
-
OpenEO provides client libraries to support the creation and execution of JavaScript, Python and R services. The full client libraries documentation is available on the official OpenEO support pages:
60
+
OpenEO provides client libraries to support the creation and execution of JavaScript, Python and R services. The full
61
+
client libraries documentation is available on the official OpenEO support pages:
To execute a service from the APEx through one of the OpenEO client libraries, it is important to use the *datacube_from_process* function.
117
+
To execute a service from the APEx through one of the OpenEO client libraries, it is important to use the
118
+
*datacube_from_process* function.
108
119
This accepts the ID and namespace of the service.
109
120
Both are made available in the service description on the EOplaza.
110
121
The full documentation on using the function is available on the official [OpenEO documentation](https://open-eo.github.io/openeo-python-client/datacube_construction.html#datacube-from-process).
@@ -114,11 +125,12 @@ Examples are available in the [OpenEO GitHub repository](https://github.com/Open
114
125
115
126
## API
116
127
117
-
OpenEO provides a fully documented API for a more advanced way to integrate features in any existing application or workflow. The API can also be used to execute EOPlaza services. The documentation is available at:
128
+
OpenEO provides a fully documented API for a more advanced way to integrate features in any existing application or workflow.
129
+
The API can also be used to execute EOPlaza services. The documentation is available at:
0 commit comments