Skip to content

Commit e6342bd

Browse files
authored
Merge pull request #161 from ESA-APEx/usecase_fixes
Usecase fixes
2 parents a456046 + 3f6e929 commit e6342bd

File tree

3 files changed

+37
-27
lines changed

3 files changed

+37
-27
lines changed

instantiation/catalog.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The product catalogue serves several beneficial scenarios for projects:
3232
and processing platforms such as openEO and OGC Application Packages. This ensures seamless integration of datasets
3333
from various providers, supporting comprehensive analysis and decision-making. This interoperability extends to other
3434
APEx tools such as the [Geospatial Explorer](geospatial_explorer.md),
35-
[Interactive Development Environments](ide.md), [User Workspaces](user_workspace.md)….
35+
[Code Server IDE](app_code_server.md), [JupyterLab IDE](app_jupyterlab.md), ….
3636

3737
* **Efficient Search and Discovery**\
3838
Users can efficiently search and discover datasets based on specific criteria such as time, location, and data type.

instantiation/usecases.qmd

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,11 @@ help, share knowledge, and collaborate on EO applications.
8989
solutions.
9090
* [**Documentation Portal**](documentation.qmd)\
9191
Comprehensive documentation and tutorial materials to assist users in navigating and utilising the services.
92-
* [**User Workspace**](user_workspace.md)\
92+
* **User Workspace**\
9393
Secure and personalised environments allow users to store, share, and manage their data and work.
94-
* [**Interactive Development Environment (IDE)**](ide.md)\
95-
Leveraging VS Code Server, these environments are tailored for EO tasks and provide development tools.
94+
* **Interactive Development Environment (IDE)**\
95+
Leveraging [Code Server](./app_code_server.md) or [JupyterLab](./app_jupyterlab.md) IDEs, these environments are tailored
96+
for EO tasks and provide development tools.
9697

9798
```{mermaid}
9899
%%| label: fig-tools-usecase2
@@ -110,8 +111,7 @@ flowchart TD ""
110111
click A href "./project_portal.html" _blank
111112
click C href "./documentation.html" _blank
112113
click D href "./forum.html" _blank
113-
click UW href "./user_workspace.html" _blank
114-
click IDE href "./ide.html" _blank
114+
click IDE href "./app_jupyterlab.html" _blank
115115
```
116116

117117
### Expected Benefits
@@ -167,10 +167,10 @@ providing powerful tools and environments for data processing and statistical an
167167

168168
### Key Components
169169

170-
* [**Interactive Development Environment (IDE)**](ide.md)\
170+
* **Interactive Development Environment (IDE)**\
171171
Equipped with tools for data analysis, statistical computation, and machine learning, leveraging the capabilities of
172-
VS Code Server.
173-
* [**User Workspace**](user_workspace.md)\
172+
[Code Server](./app_code_server.md) or [JupyterLab](./app_jupyterlab.md).
173+
* **User Workspace**\
174174
Secure and scalable environments for conducting extensive data analysis.
175175
* [**Project Portal**](project_portal.md)\
176176
Integration of visualisations into project portals to showcase data insights.
@@ -198,8 +198,7 @@ flowchart TD ""
198198
click A href "./project_portal.html" _blank
199199
click B href "./geospatial_explorer.html" _blank
200200
click C href "./catalog.html" _blank
201-
click UW href "./user_workspace.html" _blank
202-
click IDE href "./ide.html" _blank
201+
click IDE href "./app_jupyterlab.html" _blank
203202
```
204203

205204
### Expected Benefits
@@ -218,10 +217,11 @@ effectively.
218217

219218
### Key Components
220219

221-
* [**User Workspace**](user_workspace.md)\
220+
* **User Workspace**\
222221
Providing secure environments for executing data processing tasks on existing cloud-based processing platforms.
223-
* [**Interactive Development Environment (IDE)**](ide.md)\
224-
Supporting data processing scripts and workflows, including pre-configured tools for EO tasks.
222+
* **Interactive Development Environment (IDE)**\
223+
Leveraging the capabilities of [Code Server](./app_code_server.md) or [JupyterLab](./app_jupyterlab.md) IDS to support
224+
data processing scripts and workflows, including pre-configured tools for EO tasks.
225225
* [**Project Portal**](project_portal.md)\
226226
Integration of visualisations into project portals to showcase data insights.
227227
* [**Product Catalogue**](catalog.qmd)\
@@ -248,8 +248,7 @@ flowchart TD ""
248248
click A href "./project_portal.html" _blank
249249
click B href "./geospatial_explorer.html" _blank
250250
click C href "./catalog.html" _blank
251-
click UW href "./user_workspace.html" _blank
252-
click IDE href "./ide.html" _blank
251+
click IDE href "./app_jupyterlab.html" _blank
253252
```
254253

255254
### Expected Benefits

propagation/ondemandservices.qmd

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
1-
---
1+
---
22
title: On-Demand EO Services
33
---
44

55
## What is an on-demand service?
66

7-
On-demand services are scalable, cloud-based algorithms delivered as-a-Service, that users can trigger with their user-specific parametrisation.
7+
On-demand services are scalable, cloud-based algorithms delivered as-a-Service, that users can trigger with their
8+
user-specific parametrisation.
89

910
Therefore, currently APEx-compliant on-demand services should either adopt an openEO User Defined Process (UDP) or an
10-
EOAP Process implementation. This ensures that the algorithm can be hosted on one of the APEx-compliant algorithm hosting platforms and executed
11-
as an OGC API Process or through the openEO API. There are additional
11+
EOAP Process implementation. This ensures that the algorithm can be hosted on one of the APEx-compliant algorithm hosting
12+
platforms and executed
13+
as an OGC API Process or through the openEO API. There are additional
1214
[APEx compliance and interoperability guidelines](../interoperability/algohosting.md) which help ensuring FAIR compliance.
1315

14-
Also, the resulting on-demand services should be compliant to the FAIR data principles (Findable, Accessible, Interoperable and Reusable).
16+
Also, the resulting on-demand services should be compliant to the FAIR data principles (Findable, Accessible, Interoperable
17+
and Reusable).
1518

1619
## How to build an on-demand service?
1720

@@ -52,6 +55,7 @@ For further guidance on creating and using UDPs, you can explore the following r
5255
* [Official openEO specification](https://api.openeo.org/#tag/User-Defined-Processes)
5356

5457
#### Development and Testing Environments
58+
5559
While an openEO UDP can be developed on any supported environment using the
5660
existing [openEO tools](https://openeo.org/documentation/1.0/), we recommend testing the UDP on an APEx-compliant
5761
hosting platform. This ensures platform compatibility and facilitates the deployment of your UDP as an on-demand
@@ -62,14 +66,20 @@ to [this page](./platforms.md).
6266

6367
### Building an EOAP Process based service
6468

65-
Another option is to package your software using Docker containers. This approach, based on the OGC Best Practice for Earth Observation Application Packaging (EOAP), is very generic and is particularly relevant if you have an existing piece of complex software that you want to make available as a service.
69+
Another option is to package your software using Docker containers. This approach, based on the OGC Best Practice for Earth
70+
Observation Application Packaging (EOAP), is very generic and is particularly relevant if you have an existing piece of
71+
complex software that you want to make available as a service.
6672

67-
This APEx-compliant, cloud service implementation option, consists in containerizing your software (using Docker technologies) along with CWL wrappers (Common Workflow Language)[@cwl], together forming a reusable, scalable Earth Observation Application Package (EOAP) [@ap]. APEx can provide the guidance and support you need to efficiently translate your algorithm into an EOAP implementation.
73+
This APEx-compliant, cloud service implementation option, consists in containerizing your software (using Docker technologies)
74+
along with CWL wrappers [Common Workflow Language](@cwl), together forming a reusable, scalable Earth Observation Application
75+
Package (EOAP) [@ap]. APEx can provide the guidance and support you need to efficiently translate your algorithm into an
76+
EOAP implementation.
6877

6978
After your EOAP is created, it can be registered in
7079
the [APEx Algorithm Services Catalogue](../propagation/onboarding.md#apex-algorithm-services-catalogue) and associated
7180
with one or more backends or platforms capable of running it. As APEx continues to evolve, additional tools will become
72-
available that aid this process, including functionality to check if your service remains in operational state, when it has been deployed onto an APEx-compliant algorithm hosting platform.
81+
available that aid this process, including functionality to check if your service remains in operational state, when it
82+
has been deployed onto an APEx-compliant algorithm hosting platform.
7383

7484
[This tutorial](https://terradue.github.io/ogc-eo-application-package-hands-on/) explains more about this option.
7585

@@ -79,9 +89,10 @@ To develop and test an OGC Application Package, you can use one of the following
7989
necessary tools and basic infrastructure to support the development process:
8090

8191
* [ELLIP](https://ellip.terradue.com)
82-
* APEx Instantiation Services
83-
* [Workspace](../instantiation/user_workspace.md) and [IDE](../instantiation/ide.md)
84-
92+
* APEx Project Environments
93+
* [Code Server IDE](../instantiation/app_code_server.md)
94+
* [JupyterLab IDE](../instantiation/app_jupyterlab.md)
95+
8596
For a comprehensive overview of currently APEx-compliant hosting platforms, please refer
8697
to [this page](./platforms.md).
8798

0 commit comments

Comments
 (0)