Skip to content

Commit 266d3b5

Browse files
authored
Merge pull request #155 from ESA-APEx/update_algorithm_onboarding_structure
onboarding: updated structure and added support intro
2 parents 421e92f + 332851e commit 266d3b5

File tree

1 file changed

+33
-20
lines changed

1 file changed

+33
-20
lines changed

propagation/onboarding.md

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@ users to maximise the uptake of the onboarded algorithms.
1616

1717
## Support Overview
1818

19+
The APEx Algorithm Onboarding service provides support in several key areas. The support can be tailored to the needs
20+
of the project and can include one or more of the following components:
21+
22+
* **[Algorithm Hosting Platform Onboarding](#hosting-platform-onboarding-support)**\
23+
Assistance in selecting and onboarding the algorithm to an [APEx-compliant hosting platform](./platforms.md), ensuring
24+
that the algorithm is available for execution as an on-demand service.
25+
* **[APEx Algorithm Services Catalogue Integration](#apex-algorithm-services-catalogue)**\
26+
Guidance on how to integrate the hosted algorithm into the [APEx Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/),
27+
making it discoverable and accessible to the EO community.
28+
* **[Automated Testing and Benchmarking](#automated-testing-and-benchmarking)**\
29+
Provision of automated testing and benchmarking services to ensure the algorithm remains functional and accessible over
30+
time.
31+
1932
### Hosting Platform Onboarding Support
2033

2134
APEx can help to identify the different hosting environments that the project can choose from based on criteria such as
@@ -26,9 +39,28 @@ further integration into the APEx [Algorithm Services Catalogue](#apex-algorithm
2639

2740
:::{.callout-tip}
2841
A full list of the known APEx-compliant algorithm hosting platforms is
29-
available [here](ondemandservices.qmd#which-option-to-choose).
42+
available [here](./platforms.md).
43+
:::
44+
45+
### APEx Algorithm Services Catalogue
46+
47+
Through comprehensive guidelines and documentation, projects can seamlessly integrate their hosted services in the
48+
APEx [Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/). This process facilitates easy browsing
49+
and access to available algorithms, fostering collaboration and innovation within the EO community.
50+
51+
![APEx Algorithm Services Catalogue](images/catalogue.png)
52+
53+
The APEx [Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/) allows visitors to discover and
54+
select algorithms for subsequent execution on the corresponding APEx-compliant hosting environment.
55+
56+
::: {.callout-note title="Disclaimer"}
57+
APEx relies on the APEx-compliant algorithm hosting environments for algorithm execution and the provisioning of the
58+
corresponding cloud resources. Users wishing to execute an algorithm will need a valid account on the relevant hosting
59+
platform or make a request through [ESA's Network of Resources (NoR)](https://portfolio.nor-discover.org/).
3060
:::
3161

62+
Stay tuned for more detailed instructions on how to execute an algorithm through the APEx Algorithm Services Catalogue.
63+
3264
### Automated Testing and Benchmarking
3365

3466
To ensure service integrity, APEx conducts periodic, automated testing and benchmarking in close collaboration with the
@@ -56,25 +88,6 @@ the service provider indicates that the problem will not be resolved or is simpl
5688
To run the defined tests, APEx also needs permission from the hosting platform and an account with sufficient credits.
5789
Collaboration of the platform may be required to fulfil this requirement.
5890

59-
### APEx Algorithm Services Catalogue
60-
61-
Through comprehensive guidelines and documentation, projects can seamlessly integrate their hosted services in the
62-
APEx [Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/). This process facilitates easy browsing
63-
and access to available algorithms, fostering collaboration and innovation within the EO community.
64-
65-
![APEx Algorithm Services Catalogue](images/catalogue.png)
66-
67-
The APEx [Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/) allows visitors to discover and
68-
select algorithms for subsequent execution on the corresponding APEx-compliant hosting environment.
69-
70-
::: {.callout-note title="Disclaimer"}
71-
APEx relies on the APEx-compliant algorithm hosting environments for algorithm execution and the provisioning of the
72-
corresponding cloud resources. Users wishing to execute an algorithm will need a valid account on the relevant hosting
73-
platform or make a request through [ESA's Network of Resources (NoR)](https://portfolio.nor-discover.org/).
74-
:::
75-
76-
Stay tuned for more detailed instructions on how to execute an algorithm through the APEx Algorithm Services Catalogue.
77-
7891
## Considerations and Project Responsibilities
7992

8093
### Algorithm Maintenance

0 commit comments

Comments
 (0)