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: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Overview
4
4
5
-
This repository serves as a catalog for APEx compliant algorithms that are available as on-demand services on various cloud platforms. It collects and maintains metadata about these services, making them discoverable via the [APEx Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/).
5
+
This repository serves as a catalog for APEx compliant algorithms that are available as on-demand services on various cloud platforms. It collects and maintains metadata about these services, making them discoverable via the [APEx Algorithm Catalogue](https://algorithm-catalogue.apex.esa.int/).
6
6
7
7
For more information about the concepts and architecture used in this repository, please refer to the [documentation](https://esa-apex.github.io/apex_algorithms/).
8
8
@@ -15,6 +15,6 @@ We welcome contributions! To add new algorithms or improve existing records, ple
15
15
3. Add or update algorithm metadata as needed.
16
16
4. Submit a Pull Request (PR) describing your changes.
17
17
18
-
All PRs will be reviewed by the APEx team before merging. Once your PR is merged, the changes will become visible in the [APEx Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/).
18
+
All PRs will be reviewed by the APEx team before merging. Once your PR is merged, the changes will become visible in the [APEx Algorithm Catalogue](https://algorithm-catalogue.apex.esa.int/).
19
19
20
20
Please ensure your contributions comply with APEx standards and include sufficient metadata for cataloguing.
Copy file name to clipboardExpand all lines: docs/catalogue.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
---
2
-
title: APEx Algorithm Service Catalogue
2
+
title: APEx Algorithm Catalogue
3
3
---
4
4
5
-
The [APEx Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/) is a valuable and innovative resource that grants access to a wide array of high-quality EO services. It serves as a central hub for users to discover EO services tailored to their specific requirements. For EO projects, this catalogue provides an intuitive and reliable platform to showcase and offer their services to a broader community, thereby fostering collaboration and enhancing the utilization of their results.
5
+
The [APEx Algorithm Catalogue](https://algorithm-catalogue.apex.esa.int/) is a valuable and innovative resource that grants access to a wide array of high-quality EO services. It serves as a central hub for users to discover EO services tailored to their specific requirements. For EO projects, this catalogue provides an intuitive and reliable platform to showcase and offer their services to a broader community, thereby fostering collaboration and enhancing the utilization of their results.
6
6
7
-
All algorithms registered in this repository are seamlessly integrated and visualized within the APEx Algorithm Services Catalogue. This integration relies on properties defined in the OGC API Records stored in a JSON format. The information gleaned from the OGC API Records is instrumental in constructing both the overview of the catalogue and the detailed pages of each service.
7
+
All algorithms registered in this repository are seamlessly integrated and visualized within the APEx Algorithm Catalogue. This integration relies on properties defined in the OGC API Records stored in a JSON format. The information gleaned from the OGC API Records is instrumental in constructing both the overview of the catalogue and the detailed pages of each service.
{#fig-details}
11
+
{#fig-details}
12
12
13
13
14
14
This page will delve deeper into the setup and operations of this integration, providing further insights into how users can benefit from the services offered.
@@ -19,15 +19,15 @@ This page will delve deeper into the setup and operations of this integration, p
19
19
Before you begin, ensure your algorithm is hosted on an APEx-compliant platform. If you need assistance in selecting a suitable platform, refer to the [APEx Hosting Platform Onboarding Support](https://esa-apex.github.io/apex_documentation/propagation/onboarding.html#hosting-platform-onboarding-support) section.
20
20
:::
21
21
22
-
Onboarding your service to the APEx Algorithm Services Catalogue is a straightforward process. Follow these steps to get started:
22
+
Onboarding your service to the APEx Algorithm Catalogue is a straightforward process. Follow these steps to get started:
23
23
24
24
1. Start by creating an OGC API Record for your algorithm. You can use one of the existing records in the repository as a template to guide you. Make sure to fill in all the required fields and provide accurate information about your service. More details about the record structure can be found in the [Record Mapping](#record-mapping) section below.
25
25
2. Fork the current repository and add your record file to `algorithm_catalog/<provider>/<service>/records/<service>.json`. You can create the necessary subdirectories if they do not already exist.
26
-
3. Once your record is ready, submit a pull request to this repository. The APEx team will review your submission and, upon approval, your service will be added to the APEx Algorithm Services Catalogue.
26
+
3. Once your record is ready, submit a pull request to this repository. The APEx team will review your submission and, upon approval, your service will be added to the APEx Algorithm Catalogue.
27
27
28
28
# Providers and Platforms
29
29
30
-
To ensure the proper contribution of the services that are part of the APEx Algorithm Services Catalogue, it is essential to include information about the service provider and the hosting platform within the record.
30
+
To ensure the proper contribution of the services that are part of the APEx Algorithm Catalogue, it is essential to include information about the service provider and the hosting platform within the record.
31
31
32
32
## Provider Information
33
33
@@ -50,7 +50,7 @@ The following sections demonstrate how the various sections from the record are
50
50
51
51
## Service Visibility
52
52
53
-
In those cases where the service is not intended to be publicly available, the `properties.visibility` property in the record can be set to `private`. This ensures that the service will not be listed in the [APEx Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/). The default value for this property is `public`, meaning that if it is not specified, the service will be visible in the catalogue.
53
+
In those cases where the service is not intended to be publicly available, the `properties.visibility` property in the record can be set to `private`. This ensures that the service will not be listed in the [APEx Algorithm Catalogue](https://algorithm-catalogue.apex.esa.int/). The default value for this property is `public`, meaning that if it is not specified, the service will be visible in the catalogue.
Copy file name to clipboardExpand all lines: schemas/record.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@
62
62
"properties": {
63
63
"visibility": {
64
64
"type": "string",
65
-
"description": "Visibility of the service in the APEx Algorithm Services Catalogue. Set to private to ensure the service is not listed in the catalogue.",
65
+
"description": "Visibility of the service in the APEx Algorithm Catalogue. Set to private to ensure the service is not listed in the catalogue.",
0 commit comments