Skip to content

Commit 0938a4e

Browse files
authored
Merge pull request #174 from ESA-APEx/rename-catalogue
chore: renamed APEx Algorithm Services Catalogue
2 parents 1db5d59 + d1dae4a commit 0938a4e

File tree

15 files changed

+143
-127
lines changed

15 files changed

+143
-127
lines changed

_quarto.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ website:
8282
text: Ingesting STAC metadata in APEx Product Catalogue
8383
- href: guides/catalog_openeo.ipynb
8484
text: Linking APEx Product Catalogue with an openEO service
85-
- section: APEx Algorithm Services Catalogue
85+
- section: APEx Algorithm Catalogue
8686
contents:
8787
- href: guides/algorithm_services_catalogue.qmd
8888
- href: guides/algorithm_services_catalogue_benchmarks.qmd

eo_service_usage/openeo_usage.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,43 @@
22
title: openEO based services
33
---
44

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

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

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:
1016

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.
1419
* Sample code in the service description on how to execute a service.
1520

1621
## openEO backends
1722

1823
An APEx openEO service is always associated with one or more openEO backends that have been validated to produce the correct
1924
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.
2127

2228
To ensure a smooth experience, backends need to be compliant with [APEx guidelines](../interoperability/algohostingenv.md).
2329
The currently known list of compliant backends is:
2430

25-
- [CDSE openEO federation](https://openeofed.dataspace.copernicus.eu)
26-
- [openEO platform](https://openeo.cloud)
31+
* [CDSE openEO federation](https://openeofed.dataspace.copernicus.eu)
32+
* [openEO platform](https://openeo.cloud)
2733

2834
Both are federations, which means that they in fact are backed by multiple openEO instances. This increases the convenience
2935
for the APEx user, avoiding to interact with a high number of backends.
3036

3137
## Online user interface
3238

3339
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.
3542

3643
| OpenEO |
3744
|----------------------------------------------------------------------------|
@@ -40,15 +47,18 @@ Through the graphical user interface, users can execute, link, and configure dif
4047
| [Documentation](https://openeo.org/documentation/1.0/#introduction) |
4148

4249
::: {.callout-tip}
50+
4351
## Pro-tip: discovering API requests
4452

4553
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.
4756
:::
4857

4958
## Client libraries
5059

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:
5262

5363
* [JavaScript](https://openeo.org/documentation/1.0/javascript/)
5464
* [Python](https://openeo.org/documentation/1.0/python/)
@@ -104,7 +114,8 @@ taskmap_job = taskmap.save_result(format='GTiff').send_job()
104114
taskmap_job.start_and_wait().get_results()
105115
```
106116

107-
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.
108119
This accepts the ID and namespace of the service.
109120
Both are made available in the service description on the EOplaza.
110121
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
114125

115126
## API
116127

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:
118130

119131
| OpenEO |
120132
|---|
121-
| https://openeo.org/documentation/1.0/developers/api/reference.html |
133+
| <https://openeo.org/documentation/1.0/developers/api/reference.html> |
122134

123135
The following example showcases how to use the OpenEO API to execute a synchronous request for the BioPAR service:
124136

guides/eoap_writer_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Note that all the guidance material provided hereafter has APEx in mind, but can
2323
Observation applications. All APEx recommendations are made to support the FAIR principles, ensuring that your service
2424
can be easily shared within a broader community. These guidelines also facilitate the integration
2525
of your service into
26-
the [APEx Algorithm Services Catalogue](../propagation/onboarding.md#apex-algorithm-services-catalogue).
26+
the [APEx Algorithm Catalogue](../propagation/onboarding.md#apex-algorithm-catalogue).
2727

2828
For best practice illustrations and examples, on how to package Earth Observation applications, the **EOAP Guide** is
2929
published here:\

guides/udp_writer_guide.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ graph. They can:
4343
Keep in mind that APEx offers [Algorithm Porting](../propagation/porting.md)
4444
and [Algorithm Onboarding](../propagation/onboarding.md) support to help you with transforming your algorithm into an
4545
openEO UDP, onboarding it onto an [APEx-compliant hosting platform](../propagation/platforms.md), registering it in the
46-
[APEx Algorithm Services Catalogue](../propagation/onboarding.md#apex-algorithm-services-catalogue) and its onboarding onto
46+
[APEx Algorithm Catalogue](../propagation/onboarding.md#apex-algorithm-catalogue) and its onboarding onto
4747
the [ESA Network of Resources](https://portfolio.nor-discover.org/).
4848
:::
4949

@@ -53,7 +53,7 @@ User defined processes (UDPs) are one out of two standardised options that APEx
5353
service. This guide gives some concrete steps and guidelines to ensure that your UDP works well for your users. These
5454
guidelines are written with APEx in mind, but can also serve as a general guide for openEO UDPs. Where needed,
5555
recommendations and choices are made to increase uniformity across
56-
the[APEx Algorithm Services Catalogue](../propagation/onboarding.md#apex-algorithm-services-catalogue).
56+
the[APEx Algorithm Catalogue](../propagation/onboarding.md#apex-algorithm-catalogue).
5757

5858
For more background on UDP's, or a basic tutorial on creating them, the open source Python client provides
5959
[a good starting point](https://open-eo.github.io/openeo-python-client/udp.html).
@@ -110,7 +110,7 @@ a limited set of parameters, and write a single UDP for each piece.
110110

111111
This section provides some recommendations on how to name parameters in your UDP. While these are not mandatory, we
112112
recommend to consider them to avoid that users of the
113-
APEx [Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/) would be confused by variations in
113+
APEx [Algorithm Catalogue](https://algorithm-catalogue.apex.esa.int/) would be confused by variations in
114114
process parameter names.
115115

116116
Please [let us know](https://github.com/ESA-APEx/apex_documentation/issues) if you encounter a parameter that could use

0 commit comments

Comments
 (0)