Skip to content

Commit e59542a

Browse files
authored
Merge branch 'main' into private_udp
2 parents 0ec2015 + 1db5d59 commit e59542a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+17496
-5979
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ venv*
1515
package-lock.json
1616
package.json
1717
node_modules
18+
19+
**/*.quarto_ipynb

_quarto.yml

Lines changed: 51 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,32 @@ website:
2121

2222
sidebar:
2323
style: "floating"
24-
collapse-level: 2
2524
contents:
2625
- href: index.qmd
2726
text: Welcome
2827
# - href: eo_service_usage.qmd
29-
- text: On-demand EO services
28+
- section: On-demand EO services
3029
contents:
3130
- href: eo_service_usage/openeo_usage.md
3231
text: Using openEO service
3332
- href: propagation/platforms.md
3433
- href: instantiation/index.md
35-
text: Project Environments
34+
section: Project Environments
3635
contents:
3736
- href: instantiation/usecases.qmd
3837
text: Use Cases
3938
- href: instantiation/customisation.md
4039
- href: instantiation/accessibility.md
4140
- href: instantiation/geospatial_explorer.md
4241
- href: instantiation/project_portal.md
43-
- href: instantiation/user_workspace.md
44-
- href: instantiation/ide.md
42+
- href: instantiation/app_code_server.md
43+
- href: instantiation/app_jupyterlab.md
44+
- href: instantiation/app_qgis.md
4545
- href: instantiation/catalog.qmd
4646
- href: instantiation/documentation.qmd
4747
- href: instantiation/forum.md
4848
- href: propagation/index.qmd
49-
text: Algorithm Support
49+
section: Algorithm Support
5050
contents:
5151
- href: propagation/ondemandservices.qmd
5252
- href: propagation/usecases.md
@@ -57,29 +57,55 @@ website:
5757
- href: propagation/enhancement.md
5858
- href: propagation/toolboxcloud.md
5959
- href: propagation/intercomparison.md
60-
- text: Guides
60+
- section: Guides
6161
contents:
62-
- href: guides/account.md
63-
- href: guides/token.md
64-
text: Creating APEx single sign-on token
65-
- href: guides/udp_writer_guide.qmd
66-
text: Creating openEO based services
67-
- href: guides/eoap_writer_guide.md
68-
text: Creating EOAP based services
69-
- href: guides/upscaling_openeo.ipynb
70-
text: Upscaling openEO based services
71-
- href: guides/stac_catalog_ingest.ipynb
72-
text: Ingesting STAC metadata in APEx Product Catalogue
73-
- href: guides/catalog_openeo.ipynb
74-
text: Linking APEx STAC catalogue with an openEO service
75-
- href: guides/file_formats.qmd
76-
text: File format recommendations
77-
- href: guides/project_portal/index.qmd
62+
- section: Developer Guides
7863
contents:
79-
- auto: guides/project_portal/tutorials/*.qmd
64+
- section: Authentication
65+
contents:
66+
- href: guides/account.md
67+
- href: guides/token.md
68+
text: Creating APEx single sign-on token
69+
- section: openEO
70+
contents:
71+
- href: guides/udp_writer_guide.qmd
72+
text: Creating openEO based services
73+
- href: guides/upscaling_openeo.ipynb
74+
text: Upscaling openEO based services
75+
- section: EOAP
76+
contents:
77+
- href: guides/eoap_writer_guide.md
78+
text: Creating EOAP based services
79+
- section: APEx Product Catalogue
80+
contents:
81+
- href: guides/stac_catalog_ingest.ipynb
82+
text: Ingesting STAC metadata in APEx Product Catalogue
83+
- href: guides/catalog_openeo.ipynb
84+
text: Linking APEx Product Catalogue with an openEO service
85+
- section: APEx Algorithm Services Catalogue
86+
contents:
87+
- href: guides/algorithm_services_catalogue.qmd
88+
- href: guides/algorithm_services_catalogue_benchmarks.qmd
89+
- href: guides/file_formats.qmd
90+
text: File format recommendations
91+
- section: Admin Guides
92+
contents:
93+
- href: guides/account.md
94+
- href: guides/custom_domain.md
95+
text: Custom domains for your project environment
96+
- href: guides/geospatial_explorer/index.qmd
97+
contents:
98+
- auto: guides/geospatial_explorer/tutorials/*.qmd
99+
- href: guides/project_portal/index.qmd
100+
contents:
101+
- auto: guides/project_portal/tutorials/*.qmd
102+
103+
- section: Consumer Guides
104+
contents:
105+
- href: guides/geospatial_explorer/geospatial_explorer_guide.qmd
80106

81107
- href: interoperability/index.md
82-
text: Interoperability and Compliance Guidelines
108+
section: Interoperability and Compliance Guidelines
83109
contents:
84110
- href: interoperability/definitions.qmd
85111
- href: propagation/service_development.qmd

eo_service_usage/openeo_usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
title: openEO based services
33
---
44

5-
APEx services that follow the [openEO](https://openeo.org/) standard are implemented as openEO processes.
5+
Context: use of APEx services that expose the [openEO](https://openeo.org/) interface standard, when implemented as openEO processes.
66

77

8-
Services can be executed through the tools that are provided by the different processing platforms.
9-
For OpenEO based services, there is an online user interface, web editor, Client Libraries (JavaScript, Python, R) and API.
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.
1010

11-
There are several ways to discover how a service can be executed. When publishing a service on the APEx, a service provider can choose to provide the following information in the service details:
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:
1212

1313
* 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.
1414
* Sample code in the service description on how to execute a service.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Registering your service
3+
jupyter: python3
4+
execute:
5+
echo: false
6+
---
7+
8+
```{python}
9+
#| output: asis
10+
import requests
11+
url = "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/main/docs/catalogue.md"
12+
r = requests.get(url)
13+
r.raise_for_status()
14+
15+
# Convert images to use absolute URLs
16+
base_url = "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/main/docs/"
17+
content = r.text.replace("](images/", f"]({base_url}images/")
18+
19+
print(content)
20+
```
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Creating benchmarks for your service
3+
jupyter: python3
4+
execute:
5+
echo: false
6+
---
7+
8+
```{python}
9+
#| output: asis
10+
import requests
11+
url = "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/main/docs/benchmarking.md"
12+
r = requests.get(url)
13+
r.raise_for_status()
14+
15+
# Convert images to use absolute URLs
16+
base_url = "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/main/docs/"
17+
content = r.text.replace("](images/", f"]({base_url}images/")
18+
19+
print(content)
20+
```

0 commit comments

Comments
 (0)