Skip to content

Commit e45c098

Browse files
authored
Merge branch 'main' into new_ai4foodUDP
2 parents 2da58bd + 9410664 commit e45c098

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

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/).
66

77
For more information about the concepts and architecture used in this repository, please refer to the [documentation](https://esa-apex.github.io/apex_algorithms/).
88

@@ -15,6 +15,6 @@ We welcome contributions! To add new algorithms or improve existing records, ple
1515
3. Add or update algorithm metadata as needed.
1616
4. Submit a Pull Request (PR) describing your changes.
1717

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/).
1919

2020
Please ensure your contributions comply with APEx standards and include sufficient metadata for cataloguing.

docs/catalogue.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: APEx Algorithm Service Catalogue
2+
title: APEx Algorithm Catalogue
33
---
44

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

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

9-
![APEx Algorithm Services Catalogue - Overview](images/catalogue.png){#fig-overview}
9+
![APEx Algorithm Catalogue - Overview](images/catalogue.png){#fig-overview}
1010

11-
![APEx Algorithm Services Catalogue - Service Details](images/catalogue_details.png){#fig-details}
11+
![APEx Algorithm Catalogue - Service Details](images/catalogue_details.png){#fig-details}
1212

1313

1414
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
1919
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.
2020
:::
2121

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

2424
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.
2525
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.
2727

2828
# Providers and Platforms
2929

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

3232
## Provider Information
3333

@@ -50,7 +50,7 @@ The following sections demonstrate how the various sections from the record are
5050

5151
## Service Visibility
5252

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

5555
## Services Overview
5656

docs/images/catalogue.png

655 KB
Loading

docs/images/catalogue_details.png

-296 KB
Loading

schemas/record.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
"properties": {
6363
"visibility": {
6464
"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.",
6666
"enum": [
6767
"public",
6868
"private"

0 commit comments

Comments
 (0)