Skip to content

Commit

Permalink
Merge pull request #179 from OpenEnergyPlatform/feature-178-enhance-s…
Browse files Browse the repository at this point in the history 
…patial-section

Feature-178-enhance-spatial-section
  • Loading branch information
@Ludee
Ludee authored Oct 22, 2024
2 parents f570be1 + 0be9414 commit 3f7bd20
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 28 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Here is a template for new release sections
- Restrict the version number to only major and minor versions since 2.0 [(#168)](https://github.com/OpenEnergyPlatform/oemetadata/pull/168)
- Update all descriptions and examples [(#175)](https://github.com/OpenEnergyPlatform/oemetadata/pull/175)
- Build scripts use a settings file to share variables [(#177)](https://github.com/OpenEnergyPlatform/oemetadata/pull/177)
- Refactor the spatial section and add new keys for location: 'address', '@id', 'latitude', 'longitude' and for extent: 'name', '@id', 'resolutionValue', 'resolutionUnit', 'boundingBox', 'crs' [(#179)](https://github.com/OpenEnergyPlatform/oemetadata/pull/179)

### Removed

Expand Down
137 changes: 114 additions & 23 deletions metadata/v20/build_source/schemas/spatial.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,125 @@
"type": "object",
"properties": {
"location": {
"description": "A location of the data. In case of data where the location can be described as a point. May be specified as coordinates, URI or addresses with street, house number and zip code.",
"example": "52.433509, 13.535855",
"type": [
"string",
"null"
],
"description": "An object that describes a covered area or region.",
"type": "object",
"properties": {
"address": {
"description": "An address of the location of the data. May be specified with street name, house number, zip code, and city name.",
"example": "Rudower Chaussee 12, 12489 Berlin",
"type": [
"string",
"null"
],
"badge": "Silver",
"title": "Address"
},
"@id": {
"description": "A path or URI to a specific location. It can use Wikidata or OpenStreetMap.",
"example": "https://www.wikidata.org/wiki/Q77077223",
"type": [
"string",
"null"
],
"badge": "Platinum",
"title": "Address"
},
"latitude": {
"description": "The latitude (lat) information of the location.",
"example": "52.432822",
"type": [
"string",
"null"
],
"badge": "Gold",
"title": "Latitude"
},
"longitude": {
"description": "The longitude (lon) information of the location.",
"example": "13.5351004",
"type": [
"string",
"null"
],
"badge": "Gold",
"title": "Longitude"
}
},
"badge": "Silver",
"title": "Location"
"title": "Extent"
},
"extent": {
"description": "A covered area. May be the name of a region, or the geometry of a bounding box.",
"example": "Europe",
"type": [
"string",
"null"
],
"description": "An object that describes a covered area or region.",
"type": "object",
"properties": {
"name": {
"description": "The name of the region.",
"example": "Berlin",
"type": [
"string",
"null"
],
"badge": "Silver",
"title": "Extent Name"
},
"@id": {
"description": "A URI reference for the region.",
"example": "https://www.wikidata.org/wiki/Q64",
"type": [
"string",
"null"
],
"format": "uri",
"badge": "Platinum",
"title": "Extent URI"
},
"resolutionValue": {
"description": "The value of the resolution.",
"example": "100",
"type": [
"string",
"null"
],
"badge": "Silver",
"title": "Resolution Value"
},
"resolutionUnit": {
"description": "The unit of the resolution.",
"example": "m",
"type": [
"string",
"null"
],
"badge": "Silver",
"title": "Resolution Unit"
},
"boundingBox": {
"description": "The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N].",
"example": [13.08825, 52.33859, 13.76104, 52.6754],
"type": "array",
"items": {
"type": "number"
},
"minItems": 4,
"maxItems": 4,
"badge": "Gold",
"title": "Bounding Box"
},
"crs": {
"description": "The Coordinate Reference System, specified as an EPSG code.",
"example": "EPSG:4326",
"type": [
"string",
"null"
],
"badge": "Gold",
"title": " Coordinate Reference System (CRS)"
}


},
"badge": "Silver",
"title": "Extent"
},
"resolution": {
"description": "The resolution of the spatial extent. Reference to the administrative level or another spatial subdivision that exists as the smallest spatially differentiated unit size. Pixel size in case of a regular raster image.",
"example": "1 ha",
"type": [
"string",
"null"
],
"badge": "Silver",
"title": "Resolution"
}
},
"badge": "Silver",
Expand Down
23 changes: 18 additions & 5 deletions metadata/v20/metadata_key_description.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,26 @@ If a value is not yet available, use: 'ToDo'.
| 15.8 | fundingAgencyLogo | A URL to the logo or image of the funding agency. | https://upload.wikimedia.org/wikipedia/commons/8/86/DFG-logo-blau.svg | Gold |
| 15.9 | publisherLogo | A URL to the logo of the publishing agency of data. | https://reiner-lemoine-institut.de//wp-content/uploads/2015/09/rlilogo.png | Gold |

### Resource - Spatial and Temporal Keys
### Resource - Spatial Keys
| # | Key | Description | Example | Badge |
|--------|-----------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|----------|
| 16 | **spatial** | An object that describes the spatial context of the data. | | |
| 16.1 | **location** | An object that describes a covered area or region. | | |
| 16.1.1 | address | An address of the location of the data. May be specified with street name, house number, zip code, and city name. | Rudower Chaussee 12, 12489 Berlin | Silver |
| 16.1.2 | @id | A path or URI to a specific location. It can use Wikidata or OpenStreetMap. | https://www.wikidata.org/wiki/Q77077223 | Platinum |
| 16.1.3 | longitude | The latitude (lat) information of the location. | 52.432822 | Gold |
| 16.1.4 | longitude | The longitude (lon) information of the location. | 13.5351004 | Gold |
| 16.2 | **extent** | An object that describes a covered area or region. | | |
| 16.2.1 | name | The name of the region. | Berlin | Silver |
| 16.2.2 | @id | A URI reference for the region. | https://www.wikidata.org/wiki/Q64 | Platinum |
| 16.2.3 | resolutionValue | The value of the resolution. | 100 | Silver |
| 16.2.4 | resolutionUnit | The unit of the resolution. | m | Silver |
| 16.2.5 | boundingBox | The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N]. | [13.08825, 52.33859, 13.76104, 52.6754] | Gold |
| 16.2.6 | crs | The Coordinate Reference System, specified as an EPSG code. | EPSG:4326 | Gold |

### Resource - Temporal Keys
| # | Key | Description | Example | Badge |
|--------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|--------|
| 16 | **spatial** | An object that describes the spatial context of the data. | | |
| 16.1 | location | A location of the data. In case of data where the location can be described as a point. May be specified as coordinates, URI or addresses with street, house number and zip code. | 52.433509, 13.535855 | Silver |
| 16.2 | extent | A covered area. May be the name of a region, or the geometry of a bounding box. | Europe | Silver |
| 16.3 | resolution | The resolution of the spatial extent. Reference to the administrative level or another spatial subdivision that exists as the smallest spatially differentiated unit size. Pixel size in case of a regular raster image. | 1 ha | Silver |
| 17 | **temporal** | An object with the time period covered in the data. Temporal information should contain either a "referenceDate" or the keys that describe a time series, in rare cases both. | | |
| 17.1 | referenceDate | A base year, month or day. The time for which the data is should be accurate. Date Format is ISO 8601. | 2020-01-01 | Silver |
| 17.2 | **timeseries** | An array that describes the timeseries. | | |
Expand Down

0 comments on commit 3f7bd20

Please sign in to comment.