Skip to content

Commit 548f915

Browse files
authored
Merge pull request #56 from ESA-EarthCODE/review/publishing/step2
Review of Publishing - Step 2
2 parents 752e463 + 39e9c10 commit 548f915

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

pages/Technical Documentation/Data/Contributing to the EarthCODE Catalog.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -85,43 +85,52 @@ At the moment, requests to store data on ESA PRR is done by the ESA PLES enginee
8585

8686
### Description
8787

88-
The purpose of the STAC Item Catalog is to collect metadata and references to your assets in a format that can be easily reused by other scientists and automated workflows, and displayed correctly in the Open Science Catalog.
88+
The purpose of the STAC Item Catalog is to collect metadata and references to your assets in a format that can be easily reused by other scientists and automated workflows, and displayed correctly in the Open Science Catalog. The STAC Items should be created for all assets in your dataset (single files), gathered in dedicated STAC Catalogs to become available to EarthCODE users.
8989

90-
The hierarchy is structured as follows:
90+
The STAC structure helps organize and describe your data in a consistent and machine-readable way. Here’s how the hierarchy works:
9191

92-
1. Catalog – A top-level container with a title and description, grouping related data files.
93-
2. Items – Each Item represents a single data file and contains metadata such as geospatial extent, temporal range, and projection.
94-
3. Assets – Each Item has one or more Assets, which have a direct link to the actual data files and contain metadata such as file type and spectral bands.
92+
1. **STAC Catalog**
93+
A STAC Catalog is the top-level container that groups related data files (Items + Assets). It behaves much like a folder in a traditional file system and can include other catalogs or items to help organize your data logically.
94+
2. **STAC Item**
95+
A STAC Item represents a single observation (with a given spatial and temporal extent) and is defined using a GeoJSON-like structure enriched with additional metadata—such as spatial and temporal extent, projection information, geophysical variables, and more.
96+
Each Item contains one or more **Assets**, which are direct links to the actual data files. Assets may also describe specific bands, file types, or related resources associated with the item.
9597

9698
__Example folder structure__
9799
```
98100
my-item-catalog
99101
├── catalog.json
100-
└── item_1
101-
   └── item_1.json
102+
├── item_1
103+
│   └── item_1.json
104+
└── item_2
105+
└── item_2.json
102106
```
103107

104108
::: details Example `catalog.json`
105-
```json
109+
```json{15,20}
106110
{
107111
"type": "Catalog",
108-
"id": "item-catalog-for-my-data",
112+
"id": "my-item-catalog-id",
109113
"stac_version": "1.1.0",
110-
"description": "A useful description about the datasets in my project.",
114+
"description": "Provide a meaningful description of the dataset here.",
111115
"links": [
112116
{
113117
"rel": "root",
114118
"href": "./catalog.json",
115119
"type": "application/json",
116-
"title": "Item Catalog Example"
120+
"title": "Title of the Dataset"
117121
},
118122
{
119123
"rel": "item",
120-
"href": "./item_1/item_1.json",
124+
"href": "./item_1/item_1.json", // relative link to the item.json describing a single file in the dataset
125+
"type": "application/geo+json"
126+
},
127+
{
128+
"rel": "item",
129+
"href": "./item_2/item_2.json", // relative link to the item.json describing a single file in the dataset
121130
"type": "application/geo+json"
122131
},
123132
],
124-
"title": "Item Catalog Example"
133+
"title": "Tile of the Dataset"
125134
}
126135
```
127136
:::
@@ -176,18 +185,18 @@ my-item-catalog
176185
"rel": "root",
177186
"href": "../catalog.json",
178187
"type": "application/json",
179-
"title": "Item Catalog Example"
188+
"title": "Title of the Dataset"
180189
},
181190
{
182191
"rel": "parent",
183192
"href": "../catalog.json",
184193
"type": "application/json",
185-
"title": "Item Catalog Example"
194+
"title": "Title of the Dataset"
186195
}
187196
],
188197
"assets": {
189198
"data": {
190-
"href": "https://zenodo.org/records/<project-id>/files/extent_ABC.tif",
199+
"href": "https://EarthCODE/OSCAcssets/MY_PROJECT/MY_PRODUCT/item_1.tif", // link to remote asset
191200
"type": "image/tiff; application=geotiff",
192201
"eo:bands": [
193202
{

0 commit comments

Comments
 (0)