Merge pull request #61 from OvertureMaps/dev

October Release
OvertureMaps · Oct 18, 2023 · 2e05071 · 2e05071
2 parents 3a5e5b6 + c9cde00
commit 2e05071
Show file tree

Hide file tree

Showing 47 changed files with 41,882 additions and 113 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,4 @@
 .gitignore
+.vscode
+.watchman*
+.DS_Store
diff --git a/counterexamples/buildings/bad-confidence-in-source.yaml b/counterexamples/buildings/bad-confidence-in-source.yaml
@@ -0,0 +1,23 @@
+---
+id: overture:buildings:footprint:1234
+type: Feature
+geometry:
+  type: Polygon
+  coordinates: [[[0, 0], [0, 1], [1, 1], [1, 0], [0, 0]]]
+properties:
+  # Custom user properties.
+  extFoo: I am a customer user property.
+  extBar: Me too!
+  # Overture properties
+  theme: buildings
+  type: building
+  version: 1
+  updateTime: "2023-02-22T23:55:01-08:00"
+  height: 21.34
+  sources:
+  - property: ""
+    dataset: microsoftMLBuildings,
+    confidence: 100
+  - property: /properties/height
+    dataset:  metaLidarExtractions,
+    confidence: -1
diff --git a/docusaurus/docs/reference/admins/administrativeBoundary.mdx b/docusaurus/docs/reference/admins/administrativeBoundary.mdx
@@ -4,6 +4,7 @@ import generateResolverOptions from "@site/src/components/shared-libs/generateRe
 import yamlLoad from "@site/src/components/yamlLoad"
 import AdministrativeBoundarySchema from '!!raw-loader!@site/docs/_schema/admins/administrativeBoundary.yaml';
 import AdminBoundaryExample from '!!raw-loader!@site/docs/_examples/admins/administrativeBoundary/administrativeBoundary.yaml';
+import DisputedAdminBoundaryExample from '!!raw-loader!@site/docs/_examples/admins/administrativeBoundary/disputedAdministrativeBoundary.yaml';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
@@ -26,7 +27,8 @@ Administrative Boundaries are borders surrounding Administrative [Localities](lo
   </tr>
 </table>
 
-An Administrative Boundary defines the division between two Administrative [Localities](locality).
+An Administrative Boundary is typically an officially defined border between two Administrative [Localities](locality).
+In light of geopolitical issues, some Administrative Boundaries can represent standalone disputed or treaty lines and therefore do not coincide with the border of an Administrative Locality.
 The Administrative Boundary and two Administrative Localities do no share common geometry.
 
 ## Schema
@@ -46,4 +48,7 @@ The Administrative Boundary and two Administrative Localities do no share common
   <TabItem value="1" label="Administrative Boundary" default>
     <CodeBlock language="json">{ JSON.stringify(yamlLoad(AdminBoundaryExample), null, 2) }</CodeBlock>
   </TabItem>
+  <TabItem value="2" label="Disputed Administrative Boundary" default>
+    <CodeBlock language="json">{ JSON.stringify(yamlLoad(DisputedAdminBoundaryExample), null, 2) }</CodeBlock>
+  </TabItem>
 </Tabs>
diff --git a/docusaurus/docs/reference/base/land.mdx b/docusaurus/docs/reference/base/land.mdx
@@ -0,0 +1,36 @@
+---
+title: land
+---
+
+import CodeBlock from '@theme/CodeBlock';
+import JSONSchemaViewer from "@theme/JSONSchemaViewer";
+import generateResolverOptions from "@site/src/components/shared-libs/generateResolverOptions"
+import yamlLoad from "@site/src/components/yamlLoad"
+import LandSchema from "!!raw-loader!@site/docs/_schema/base/land.yaml";
+
+import SandDuneExample from "!!raw-loader!@site/docs/_examples/base/land-sand-example.yaml";
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Land
+
+## Schema
+
+<Tabs>
+  <TabItem value="browsable" label="Browsable" default>
+    <JSONSchemaViewer schema={ yamlLoad(LandSchema) } resolverOptions={ generateResolverOptions({remote: true, yamlBasePath: '/base'})}/>
+  </TabItem>
+  <TabItem value="yaml" label="YAML" default>
+    <CodeBlock language="jsx">{LandSchema}</CodeBlock>
+  </TabItem>
+</Tabs>
+
+## Examples
+
+<Tabs>
+  <TabItem value="1" label="Sand Dune (Polyon)" default>
+    <CodeBlock language="json">{ JSON.stringify(yamlLoad(SandDuneExample), null, 2) }</CodeBlock>
+  </TabItem>
+
+</Tabs>
diff --git a/docusaurus/docs/reference/base/landUse.mdx b/docusaurus/docs/reference/base/landUse.mdx
@@ -0,0 +1,25 @@
+---
+title: landUse
+---
+
+import CodeBlock from '@theme/CodeBlock';
+import JSONSchemaViewer from "@theme/JSONSchemaViewer";
+import generateResolverOptions from "@site/src/components/shared-libs/generateResolverOptions"
+import yamlLoad from "@site/src/components/yamlLoad"
+import LandUseSchema from "!!raw-loader!@site/docs/_schema/base/landUse.yaml";
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Land Use
+
+## Schema
+
+<Tabs>
+  <TabItem value="browsable" label="Browsable" default>
+    <JSONSchemaViewer schema={ yamlLoad(LandUseSchema) } resolverOptions={ generateResolverOptions({remote: true, yamlBasePath: '/base'})}/>
+  </TabItem>
+  <TabItem value="yaml" label="YAML" default>
+    <CodeBlock language="jsx">{LandUseSchema}</CodeBlock>
+  </TabItem>
+</Tabs>
diff --git a/docusaurus/docs/reference/base/water.mdx b/docusaurus/docs/reference/base/water.mdx
@@ -0,0 +1,41 @@
+---
+title: water
+---
+
+import CodeBlock from '@theme/CodeBlock';
+import JSONSchemaViewer from "@theme/JSONSchemaViewer";
+import generateResolverOptions from "@site/src/components/shared-libs/generateResolverOptions"
+import yamlLoad from "@site/src/components/yamlLoad"
+import WaterSchema from "!!raw-loader!@site/docs/_schema/base/water.yaml";
+
+import RiverExample from "!!raw-loader!@site/docs/_examples/base/water-river-example.yaml";
+import RiverExampleWikidata from "!!raw-loader!@site/docs/_examples/base/water-river-with-wikidata.yaml";
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Water
+
+## Schema
+
+<Tabs>
+  <TabItem value="browsable" label="Browsable" default>
+    <JSONSchemaViewer schema={ yamlLoad(WaterSchema) } resolverOptions={ generateResolverOptions({remote: true, yamlBasePath: '/base'})}/>
+  </TabItem>
+  <TabItem value="yaml" label="YAML" default>
+    <CodeBlock language="jsx">{WaterSchema}</CodeBlock>
+  </TabItem>
+</Tabs>
+
+## Examples
+
+<Tabs>
+  <TabItem value="1" label="River Example" default>
+    <CodeBlock language="json">{ JSON.stringify(yamlLoad(RiverExample), null, 2) }</CodeBlock>
+  </TabItem>
+
+  <TabItem value="2" label="Prominent River Example" default>
+    <CodeBlock language="json">{ JSON.stringify(yamlLoad(RiverExampleWikidata), null, 2) }</CodeBlock>
+  </TabItem>
+
+</Tabs>
diff --git a/docusaurus/docs/themes/base/index.mdx b/docusaurus/docs/themes/base/index.mdx
@@ -0,0 +1,20 @@
+---
+title: Base
+---
+
+# Base Theme
+
+The Overture Base Theme provides additional context such as land and water that are critical to rendering a complete basemap. These features are currently derived from the [Daylight Earth Tables](https://daylightmap.org/earth/) schema and include the [Daylight Coastlines](https://daylightmap.org/coastlines.html).
+
+## Key Schema Design Choices
+
+1. Basic classification of features into type, subType, and class where appropriate.
+2. Parsing and normalization of common OSM tags, such as `height` and `ele`.
+4. Extraction of consistent OSM tags, such as wikidata to top-level properties.
+3. Direct pass-through of remaining relevant OSM tags.
+
+## Current Types:
+
+1. [land](/reference/base/landuse): Physical representations of land surfaces. Global land derived from the inverse of OSM Coastlines. Translates `natural` tags from OpenStreetMap.
+2. [landUse](/reference/base/landUse): Classifications of the human use of a section of land. Translates `landuse` from OpenStreetMap tag from OpenStreetMap.
+3. [water](/reference/base/water): Physical representations of inland and ocean marine surfaces. Translates `natural` and `waterway` tags from OpenStreetMap.
diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js
@@ -2,41 +2,6 @@
 const sidebars = {
   docs: [
     'index',
-    // {
-    //   type: 'category',
-    //   label: 'Core Concepts',
-    //   link: {
-    //     type: 'generated-index',
-    //     slug: '/concepts',
-    //   },
-    //   collapsed: false,
-    //   items: [
-    //       'concepts/feature',
-    //       'concepts/theme',
-    //       'concepts/gers',
-    //   ]
-    // },
-    /*
-      GERS
-    {
-      type: 'category',
-      label: 'Global Entity Reference System',
-      // link: {
-      //   type: 'doc',
-      //   id: 'gers/gers'
-      // },
-      collapsed: true,
-      items: [
-        {
-          type: 'doc',
-          id:'gers/gers',
-          label: 'Overview'
-        },
-        'gers/scenarios',
-        'gers/terminology'
-      ]
-    },
-    // */
     /*
       Themes
     */
@@ -54,6 +19,7 @@ const sidebars = {
           id: 'themes/admins/admins',
           label: 'Admins'
         },
+        'themes/base/index',
         'themes/buildings/building',
         'themes/places/place',
         {
@@ -88,21 +54,25 @@ const sidebars = {
         {
           type: 'category',
           label: 'admins',
-          // link: {
-          //   type: 'generated-index',
-          // },
           collapsed: false,
           items: [
               'reference/admins/administrativeBoundary',
               'reference/admins/locality',
           ]
         },
+        {
+          type: 'category',
+          label: 'base',
+          collapsed: false,
+          items: [
+              'reference/base/land',
+              'reference/base/landUse',
+              'reference/base/water',
+          ]
+        },
         {
           type: 'category',
           label: 'buildings',
-          // link: {
-          //   type: 'generated-index',
-          // },
           collapsed: false,
           items: [
             'reference/buildings/building',
@@ -111,9 +81,6 @@ const sidebars = {
         {
           type: 'category',
           label: 'places',
-          // link: {
-          //   type: 'generated-index',
-          // },
           collapsed: false,
           items: [
             'reference/places/place',
@@ -122,15 +89,12 @@ const sidebars = {
         {
           type: 'category',
           label: 'transportation',
-          // link: {
-          //   type: 'generated-index',
-          // },
           collapsed: false,
           items: [
             'reference/transportation/connector',
             'reference/transportation/segment',
           ]
-        },
+        }
       ]
     }
   ],

diff --git a/docusaurus/src/YAML_FILE_TREE.js b/docusaurus/src/YAML_FILE_TREE.js
@@ -13,6 +13,11 @@ const _default = {
     '/transportation/connector.yaml': require('!!raw-loader!@site/docs/_schema/transportation/connector.yaml'),
     '/transportation/segment.yaml': require('!!raw-loader!@site/docs/_schema/transportation/segment.yaml'),
 
+    '/base/defs.yaml': require('!!raw-loader!@site/docs/_schema/base/defs.yaml'),
+    '/base/land.yaml': require('!!raw-loader!@site/docs/_schema/base/land.yaml'),
+    '/base/landUse.yaml': require('!!raw-loader!@site/docs/_schema/base/landUse.yaml'),
+    '/base/water.yaml': require('!!raw-loader!@site/docs/_schema/base/water.yaml'),
+
     '/defs.yaml': require('!!raw-loader!@site/docs/_schema/defs.yaml'),
     '/schema.yaml': require('!!raw-loader!@site/docs/_schema/schema.yaml')
 

diff --git a/examples/admins/administrativeBoundary/disputedAdministrativeBoundary.yaml b/examples/admins/administrativeBoundary/disputedAdministrativeBoundary.yaml
@@ -0,0 +1,21 @@
+---
+type: Feature
+geometry:
+  type: LineString
+  coordinates:
+  - - -61.8743292
+    - 48.8068635
+  - - -78.4016703
+    - 26.273714
+  - - -120.7749598
+    - 32.2499745
+  - - -126.928757
+    - 49.0378679
+properties:
+  theme: admins
+  type: administrativeBoundary
+  updateTime: '2023-02-22T23:55:01-08:00'
+  version: 0
+  adminLevel: 2
+  maritime: true
+  geopolDisplay: disputed
diff --git a/examples/base/land-sand-example.yaml b/examples/base/land-sand-example.yaml
@@ -0,0 +1,24 @@
+---
+id: "overture:land:example:1"
+type: Feature
+geometry:
+  type: Polygon
+  coordinates: [[[34.4379197, 28.7592689], [34.4380109, 28.7595816], [34.4380173, 28.7601587], [34.4380538, 28.7606186],[34.4381540, 28.7609863], [34.4380735, 28.7612459], [34.4377346, 28.7608396], [34.4377158, 28.7606139],[34.4377105, 28.7605527], [34.4376300, 28.7604258], [34.4376407, 28.7603599], [34.4376488, 28.7602494],[34.4376863, 28.7599673], [34.4376675, 28.7597980], [34.4376890, 28.7596216], [34.4379197, 28.7592689]]]
+properties:
+  theme: base
+  type: land
+  subType: sand
+  class: dune
+  names:
+      common:
+        - value: Hadeida
+          language: local
+  sourceTags:
+    natural: dune
+    surface: sand
+  sources:
+    - recordId: w407753930@3
+      property: ""
+      dataset: OpenStreetMap
+  version: 0
+  updateTime: "2023-09-27T00:00:00Z"
diff --git a/examples/base/water-river-example.yaml b/examples/base/water-river-example.yaml
@@ -0,0 +1,24 @@
+---
+type: Feature
+geometry:
+  type: LineString
+  coordinates: [[-91.8307764, 43.7899936], [-91.8309309, 43.7901326], [-91.8315202, 43.7906232], [-91.8320790, 43.7911798], [-91.8325770, 43.7917638], [-91.8328390, 43.7921615]  ]
+properties:
+  theme: base
+  type: water
+  subType: river
+  class: river
+  names:
+    common:
+      - value: Root River
+        language: local
+  sourceTags:
+    waterway: river
+  sources:
+    - recordId: w54320702@1
+      property: ""
+      dataset: OpenStreetMap
+  isSalt: false
+  isIntermittent: false
+  version: 0
+  updateTime: "2023-09-27T00:00:00Z"
diff --git a/examples/base/water-river-with-wikidata.yaml b/examples/base/water-river-with-wikidata.yaml
@@ -0,0 +1,23 @@
+---
+type: Feature
+geometry:
+  type: LineString
+  coordinates: [ [-39.1468243, -14.9090246], [-39.1461180, -14.9085012], [-39.1455792, -14.9079805], [-39.1456091, -14.9073441], [-39.1458785, -14.9066499], [-39.1458186, -14.9058977], [-39.1459084, -14.9051167], [-39.1465970, -14.9046249], [-39.1471657, -14.9039596], [-39.1474351, -14.9032942], [-39.1474052, -14.9027157], [-39.1477046, -14.9023107], [-39.1480638, -14.9022528], [-39.1484230, -14.9014139], [-39.1484529, -14.9005750], [-39.1480039, -14.9001700], [-39.1474651, -14.8992153], [-39.1466868, -14.8986657], [-39.1460581, -14.8981450], [-39.1455492, -14.8972482], [-39.1449505, -14.8958596], [-39.1445314, -14.8947024], [-39.1445314, -14.8940370], [-39.1446811, -14.8931113], [-39.1444117, -14.8921277], [-39.1436932, -14.8918673], [-39.1430047, -14.8919252], [-39.1422264, -14.8919830], [-39.1418073, -14.8914334], [-39.1413284, -14.8910284], [-39.1409175, -14.8902377], [-39.1410327, -14.8898924], [-39.1413069, -14.8898168], [-39.1418373, -14.8898712], [-39.1423162, -14.8899001], [-39.1431262, -14.8898804], [-39.1439305, -14.8894827], [-39.1445995, -14.8892175], [-39.1448021, -14.8890297], [-39.1447110, -14.8888297], [-39.1443126, -14.8881643], [-39.1441812, -14.8872844], [-39.1442252, -14.8870763], [-39.1444859, -14.8860420], [-39.1446963, -14.8855633], [-39.1451900, -14.8849530], [-39.1456690, -14.8844612], [-39.1456390, -14.8838826], [-39.1453996, -14.8836222], [-39.1447410, -14.8835643], [-39.1440824, -14.8833908], [-39.1435436, -14.8829279], [-39.1428551, -14.8824650], [-39.1420768, -14.8821467], [-39.1412386, -14.8819442], [-39.1408494, -14.8814524], [-39.1406698, -14.8809316], [-39.1401609, -14.8806423], [-39.1395921, -14.8801216], [-39.1390832, -14.8796876], [-39.1383648, -14.8794272], [-39.1377661, -14.8793404], [-39.1375266, -14.8796876], [-39.1374668, -14.8801216], [-39.1371674, -14.8802373], [-39.1366585, -14.8801794], [-39.1360299, -14.8798322], [-39.1352516, -14.8794272], [-39.1346229, -14.8793693], [-39.1338745, -14.8792536], [-39.1331860, -14.8791668], [-39.1326771, -14.8790222], [-39.1318988, -14.8792247], [-39.1314797, -14.8789064], [-39.1313600, -14.8783857], [-39.1314498, -14.8780096], [-39.1318988, -14.8780385], [-39.1322580, -14.8781542], [-39.1327669, -14.8779806], [-39.1331860, -14.8774888], [-39.1331561, -14.8769970], [-39.1327969, -14.8765051], [-39.1317491, -14.8760422], [-39.1310606, -14.8761869], [-39.1301027, -14.8763026], [-39.1294741, -14.8762447], [-39.1291149, -14.8758686], [-39.1290550, -14.8754636], [-39.1292047, -14.8750007], [-39.1291131, -14.8745904], [-39.1290550, -14.8742195], [-39.1285760, -14.8736698], [-39.1281569, -14.8732069], [-39.1280846, -14.8729233], [-39.1283500, -14.8722189], [-39.1284563, -14.8719339], [-39.1290849, -14.8714999], [-39.1297734, -14.8711527], [-39.1302930, -14.8707987], [-39.1304147, -14.8705105], [-39.1302823, -14.8702269], [-39.1299830, -14.8697350], [-39.1295340, -14.8693010], [-39.1289352, -14.8695903], [-39.1284563, -14.8698507], [-39.1277977, -14.8699665], [-39.1273188, -14.8701690], [-39.1268697, -14.8703715], [-39.1263908, -14.8701401], [-39.1262710, -14.8696771], [-39.1260016, -14.8690695], [-39.1256424, -14.8687224], [-39.1250437, -14.8684620], [-39.1242953, -14.8683173], [-39.1237265, -14.8680858], [-39.1227087, -14.8678833], [-39.1216012, -14.8675650], [-39.1210324, -14.8673914], [-39.1202241, -14.8673914], [-39.1192961, -14.8672468], [-39.1188471, -14.8670153], [-39.1183682, -14.8664367], [-39.1179191, -14.8662631], [-39.1176198, -14.8659159], [-39.1176497, -14.8654819], [-39.1180229, -14.8651632], [-39.1179491, -14.8647585], [-39.1174102, -14.8643245], [-39.1171109, -14.8639484], [-39.1166319, -14.8638905], [-39.1161530, -14.8640931], [-39.1158237, -14.8644981], [-39.1152549, -14.8644692], [-39.1147760, -14.8645560], [-39.1140874, -14.8649032], [-39.1137774, -14.8647180], [-39.1134588, -14.8649032], [-39.1130098, -14.8646717], [-39.1128002, -14.8642956], [-39.1123512, -14.8642956], [-39.1113933, -14.8635433], [-39.1106150, -14.8630515], [-39.1099564, -14.8627332], [-39.1095972, -14.8626175], [-39.1091482, -14.8622992], [-39.1087590, -14.8625885], [-39.1083698, -14.8632251], [-39.1080106, -14.8642088], [-39.1075017, -14.8645560], [-39.1071126, -14.8647875], [-39.1065737, -14.8642956], [-39.1061247, -14.8641220], [-39.1052865, -14.8636301], [-39.1045381, -14.8632251], [-39.1039694, -14.8629068], [-39.1033707, -14.8629936], [-39.1025325, -14.8633119], [-39.1018440, -14.8635144], [-39.1009160, -14.8634276], [-39.0998982, -14.8630225], [-39.0990646, -14.8625091], [-39.0985212, -14.8617784], [-39.0982218, -14.8614022], [-39.0982218, -14.8609682], [-39.0980422, -14.8606210], [-39.0980722, -14.8600424], [-39.0983116, -14.8586825], [-39.0984314, -14.8580459], [-39.0986709, -14.8576698], [-39.0987008, -14.8572936], [-39.0990600, -14.8572068], [-39.0998683, -14.8572357], [-39.1004071, -14.8570621], [-39.1009160, -14.8565703], [-39.1013950, -14.8560784], [-39.1015921, -14.8558693] ]
+properties:
+  theme: base
+  type: water
+  subType: river
+  class: river
+  names:
+    common:
+      - value: Rio Santana
+        language: local
+  sourceTags:
+    waterway: river
+  sources:
+    - recordId: w353912370@4
+      property: ""
+      dataset: OpenStreetMap
+  wikidata: Q7420045
+  version: 0
+  updateTime: "2023-09-27T00:00:00Z"