Skip to content

Commit e6f6478

Browse files
committed
docs: started initial documentation
1 parent 0aaec1f commit e6f6478

File tree

4 files changed

+55
-1
lines changed

4 files changed

+55
-1
lines changed

algorithm_catalog/vito/biopar/openeo_udp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Calculate various biophysical parameters for an area defined by a polygon. The result is a raster file
44
containing the parameter values. A strict CloudMask is applied to avoid cloud contamination.
5-
                   
5+
66
The **Leaf Area Index (LAI)** is half the total area of a canopy's green elements
77
per unit of horizontal ground area. The satellite-derived value corresponds to the total green LAI
88
of all the canopy layers, including the understory, which may represent a very significant

docs/_quarto.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ website:
2626
- href: index.md
2727
text: Welcome
2828
- href: benchmarking.md
29+
- text: APEx Service Records
30+
contents:
31+
- href: records/create.md
32+
- href: records/visualise.md
2933

3034
format:
3135
html:

docs/records/create.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Creating APEx Service Records"
3+
format: html
4+
---
5+
Each APEx Service is defined as an OGC API Record, following the [APEx Service - OGC API Record JSON schema](https://github.com/ESA-APEx/apex_algorithms/blob/main/schemas/record.json). This standardized approach ensures consistency across APEx Services, facilitating seamless integration with other tools such as the [APEx Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/).
6+
7+
## Creating a New OGC API Record
8+
9+
To define a new APEx service as an OGC API Record, follow these steps:
10+
11+
1. Start by creating a new branch for your service.
12+
13+
2. Create the JSON record for your service:
14+
* Use the following folder structure: `algorithm_catalog/<organization>/<service_id>/records/<service_id.json>`
15+
* Structure your JSON record according to the [APEx Service - OGC API Record JSON schema](https://github.com/ESA-APEx/apex_algorithms/blob/main/schemas/record.json).
16+
* More tips on how you can ensure the proper visualization in the [APEx Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/) are available [here](./visualise.md).
17+
18+
3. Before submission, ensure your record is compliant:
19+
* Use an online validator like [JSON Schema Validator](https://www.jsonschemavalidator.net/).
20+
* Alternatively, run unit test validation using [test_records.py](../../qa/unittests/tests/test_records.py).
21+
22+
4. Submit your service record:
23+
* Once validated, push your changes to your branch and create a GitHub pull request.
24+
* After review and a successful GitHub Actions build, the APEx team will merge your pull request, officially integrating your record into the APEx catalog.

docs/records/visualise.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Visualisation of APEx Service Records in APEx Algorithm Services Catalog"
3+
format: html
4+
---
5+
6+
Each record from the APEx catalog is visualized in the [APEx Algorithm Services Catalogue](https://algorithm-catalogue.apex.esa.int/).
7+
This document provides an overview of how the different components of the service record are translated into catalog's graphical user interface.
8+
9+
## Service Catalog
10+
11+
![APEx Algorithm Services Catalog - Overview](images/catalog.png)
12+
13+
The service catalog provides an overview of all the services. The entries and all of the information are dynamically loaded based on the records inside this repository.
14+
The following table provides an overview of how the different components are mapped to the visualization.
15+
16+
17+
| Component | Example | Record Property |
18+
|-------------|--------------------------------|--------------------------|
19+
| Title | Best-Available-Pixel Composite | `properties.title` |
20+
| Description | A compositing algorithm... | `properties.description` |
21+
| Tags | composite | `properties.keywords` |
22+
23+
## Service Details Page
24+
25+
26+

0 commit comments

Comments
 (0)