Skip to content

Commit f2522e4

Browse files
committed
osc:themes -> themes
1 parent 5b8bd0b commit f2522e4

File tree

5 files changed

+58
-11
lines changed

5 files changed

+58
-11
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212

1313
### Changed
1414

15+
- Use `themes` instead of the `osc:themes`
16+
1517
### Deprecated
1618

1719
### Removed
1820

21+
- `osc:themes`
22+
1923
### Fixed
2024

2125
## [1.0.0-rc.3]

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ A set of satellite missions which provided input for the product.
5252
## Fields
5353

5454
The fields in the table below can be used in these parts of STAC documents:
55+
5556
- [x] Catalogs
5657
- [x] Collections
5758
- [x] Item Properties
@@ -71,23 +72,24 @@ As such the extension does not validate Collection summaries.
7172
| osc:region | string | The name of the geographic region the project or product is dealing with if any, e.g `"Arctic"` or `"Agulhas"`. |
7273
| osc:variables | \[string] | The names of the variables the product is observing, e.g `"Wind stress"` or `"Geomagnetic field"`. |
7374
| osc:missions | \[string] | The names of the satellite missions which provided input for this project or product. |
74-
| osc:themes | \[string] | The names of the themes the project or product is dealing with. |
7575

7676
Fields that apply when the `osc:type` is set to `product`:
77+
7778
- osc:name
7879
- osc:status - **REQUIRED**
7980
- osc:project - **REQUIRED**
8081
- osc:region
8182
- osc:variables
8283
- osc:missions
83-
- osc:themes
84+
- [themes](#themes)
8485

8586
Fields that apply when the `osc:type` is set to `project`:
87+
8688
- osc:name
8789
- osc:status - **REQUIRED**
8890
- osc:region
8991
- osc:missions
90-
- osc:themes
92+
- [themes](#themes)
9193
- [contacts](#contacts)
9294

9395
### Contacts
@@ -103,6 +105,17 @@ The following `roles` for contacts SHALL be used:
103105
- The role for the technical officer of a project is `technical_officer`.
104106
- The role for consortium partners is `consortium_member`.
105107

108+
### Themes
109+
110+
The following fields should be implemented from the [Themes extension](https://github.com/stac-extensions/themes):
111+
112+
| Field Name | Type | Description |
113+
| ---------- | ---- | ----------- |
114+
| themes | \[[Theme Object](https://github.com/stac-extensions/themes/blob/v1.0.0/README.md#theme-object)] | The names of the themes the project or product is dealing with. |
115+
116+
The themes field can contain concepts from different controlled vocabularies (via `scheme`).
117+
By default this extension only asks to add concepts for the scheme `https://github.com/stac-extensions/osc#theme`.
118+
106119
## Contributing
107120

108121
All contributions are subject to the
@@ -118,18 +131,21 @@ To run tests locally, you'll need `npm`, which is a standard part of any [node.j
118131

119132
First you'll need to install everything with npm once. Just navigate to the root of this repository and on
120133
your command line run:
134+
121135
```bash
122136
npm install
123137
```
124138

125139
Then to check markdown formatting and test the examples against the JSON schema, you can run:
140+
126141
```bash
127142
npm test
128143
```
129144

130145
This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
131146

132147
If the tests reveal formatting problems with the examples, you can fix them with:
148+
133149
```bash
134150
npm run format-examples
135151
```

examples/4dionosphere-swarm-vip/catalog.json

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,23 @@
55
"description": "In the project Swarm satellite data and other datasets are used to determine determine the dominant scales in the ionosphere at different geomagnetic conditions and create a semi-empiric dynamic model of the ionosphere.",
66
"stac_extensions": [
77
"https://stac-extensions.github.io/osc/v1.0.0-rc.3/schema.json",
8+
"https://stac-extensions.github.io/themes/v1.0.0/schema.json",
89
"https://stac-extensions.github.io/contacts/v0.1.1/schema.json"
910
],
1011
"title": "SWARM VIP",
1112
"osc:name": "4DIONOSPHERE (SWARM VIP)",
1213
"osc:status": "completed",
1314
"osc:type": "project",
14-
"osc:themes": [
15-
"Magnetosphere_Ionosphere"
15+
"themes": [
16+
{
17+
"concepts": [
18+
{
19+
"id": "magnetosphere-ionosphere",
20+
"title": "Magnetosphere Ionosphere"
21+
}
22+
],
23+
"scheme": "https://github.com/stac-extensions/osc#theme"
24+
}
1625
],
1726
"contacts": [
1827
{

examples/4dionosphere-swarm-vip/model-ionosphere-4dionosphere/collection.json

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
"id": "model-ionosphere-4dionosphere",
44
"stac_version": "1.0.0",
55
"stac_extensions": [
6-
"https://stac-extensions.github.io/osc/v1.0.0-rc.3/schema.json"
6+
"https://stac-extensions.github.io/osc/v1.0.0-rc.3/schema.json",
7+
"https://stac-extensions.github.io/themes/v1.0.0/schema.json"
78
],
89
"description": "Semi-empiric model and improvement of the forecasting capabilities for extreme space weather events. Swarm-VIP project performs extensive and complex statistical analysis on Swarm electron density, electric and magnetic field data focusing on: 1) the ionospheric climate/weather during quiet geomagnetic conditions; 2) the extreme events such as geomagnetic storms / superstorms and 3) the physics of ionospheric perturbations and small-scale variability. Currently the access to the results is restricted. If you would like to gain access, please contact Lasse Clausen (http://www.mn.uio.no/fysikk/english/people/aca/lbnc/) or Wojciech Miloch (http://www.mn.uio.no/fysikk/english/people/aca/wojciecm/index.html).",
910
"title": "Semi-empiric model of ionosphere processes_SWARM",
@@ -16,8 +17,16 @@
1617
],
1718
"osc:status": "completed",
1819
"osc:type": "product",
19-
"osc:themes": [
20-
"Magnetosphere_Ionosphere"
20+
"themes": [
21+
{
22+
"concepts": [
23+
{
24+
"id": "magnetosphere-ionosphere",
25+
"title": "Magnetosphere Ionosphere"
26+
}
27+
],
28+
"scheme": "https://github.com/stac-extensions/osc#theme"
29+
}
2130
],
2231
"keywords": [
2332
"theme:Magnetosphere_Ionosphere",

examples/4dionosphere-swarm-vip/model-ionosphere-4dionosphere/item.json

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
"id": "example",
44
"stac_version": "1.0.0",
55
"stac_extensions": [
6-
"https://stac-extensions.github.io/osc/v1.0.0-rc.3/schema.json"
6+
"https://stac-extensions.github.io/osc/v1.0.0-rc.3/schema.json",
7+
"https://stac-extensions.github.io/themes/v1.0.0/schema.json"
78
],
89
"geometry": null,
910
"properties": {
@@ -16,8 +17,16 @@
1617
],
1718
"osc:status": "completed",
1819
"osc:type": "product",
19-
"osc:themes": [
20-
"Magnetosphere_Ionosphere"
20+
"themes": [
21+
{
22+
"concepts": [
23+
{
24+
"id": "magnetosphere-ionosphere",
25+
"title": "Magnetosphere Ionosphere"
26+
}
27+
],
28+
"scheme": "https://github.com/stac-extensions/osc#theme"
29+
}
2130
],
2231
"keywords": [
2332
"theme:Magnetosphere_Ionosphere",

0 commit comments

Comments
 (0)