Release 0.6.0

GIScience · Oct 6, 2021 · bafb826 · bafb826
1 parent b0351cf
commit bafb826
Show file tree

Hide file tree

Showing 17 changed files with 88 additions and 87 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## Current Main
+## 0.6.0
 
 ### Breaking Changes
 

diff --git a/docs/api.md b/docs/api.md
@@ -6,33 +6,32 @@
 
 ```txt
 {
-  "apiVersion": "0.5.1",
+  "apiVersion": "0.6.0",
   "attribution": {
     "text": "© OpenStreetMap contributors",
     "url": "https://ohsome.org/copyrights"
   },
   "type": "Feature",
   "geometry": {
     "type": "MultiPolygon",
-    "coordinates": [...]
+    "coordinates": [ ... ]
   },
   "properties": {
     "metadata.name": "GHS-POP Comparison Buildings",
-    "metadata.description": "..."
+    "metadata.description": "Comparison between population density and feature density.\nThis can give an estimate if mapping has been completed.\n",
     "layer.name": "Building Count",
-    "layer.description": "..."
-    "result.timestamp_oqt": "..."
-    "result.timestamp_osm": "...",
+    "layer.description": "All buildings as defined by all objects tagged with 'building=*'.\n",
+    "result.timestamp_oqt": "2021-10-05T09:33:30.671060+00:00",
+    "result.timestamp_osm": "2021-09-26T20:00:00+00:00",
     "result.label": "green",
     "result.value": 1,
     "result.description": "...",
-    "result.svg": "..."
-    "result.data": "...",
-    "data.pop_count": "...",
-    "data.area": "...",
-    "data.pop_count_per_sqkm": "...",
-    "data.feature_count": "...",
-    "data.feature_count_per_sqkm": "..."
+    "result.svg": "...",
+    "data.pop_count": 533351.7174390131,
+    "data.area": 70.29342423663759,
+    "data.pop_count_per_sqkm": 7587.5051362347085,
+    "data.feature_count": 69993,
+    "data.feature_count_per_sqkm": 995.7261402485354
   }
 }
 ```
@@ -42,53 +41,55 @@
 
 ```txt
 {
-  "apiVersion": "0.5.1",
+  "apiVersion": "0.6.0",
   "attribution": {
     "text": "© OpenStreetMap contributors",
     "url": "https://ohsome.org/copyrights"
   },
   "type": "Feature",
   "geometry": {
     "type": "MultiPolygon",
-    "coordinates": [...]
+    "coordinates": [ ... ]
   },
   "properties": {
     "report.metadata.name": "Simple Report",
-    "report.metadata.description": "...",
+    "report.metadata.description": "This report shows the quality for two indicators:\nmapping-saturation and ghspop-comparison.\nIt's main function is to test the interactions between\ndatabase, api and website.\n",
     "report.result.label": "yellow",
     "report.result.value": 0.75,
-    "report.result.description": "...",
+    "report.result.description": "At least one indicator shows only medium quality.\nYou should inspect the results for the individual indicators\nto identify potential data quality concerns.\n",
     "indicators.0.metadata.name": "Mapping Saturation",
-    "indicators.0.metadata.description": "...",
+    "indicators.0.metadata.description": "Calculate if mapping has saturated.\n",
     "indicators.0.layer.name": "Building Count",
-    "indicators.0.layer.description": "...",
-    "indicators.0.result.timestamp_oqt": "...",
-    "indicators.0.result.timestamp_osm": "...",
+    "indicators.0.layer.description": "All buildings as defined by all objects tagged with 'building=*'.\n",
+    "indicators.0.result.timestamp_oqt": "2021-10-05T09:33:30.851900+00:00",
+    "indicators.0.result.timestamp_osm": "2021-09-01T00:00:00+00:00",
     "indicators.0.result.label": "yellow",
     "indicators.0.result.value": 0.5,
-    "indicators.0.result.description": "..."
-    "indicators.0.result.svg": "..."
-    "indicators.0.result.data": "...",
-    "indicators.0.data.time_range": "...",
-    "indicators.0.data.saturation": "...",
-    "indicators.0.data.growth": "...",
-    "indicators.0.data.preprocessing_results": "...",
+    "indicators.0.result.description": "...",
+    "indicators.0.result.svg": "...",
+    "indicators.0.data.time_range": "2008-01-01//P1M",
+    "indicators.0.data.values": [ ... ],
+    "indicators.0.data.values_normalized": [ ... ]
+    "indicators.0.data.timestamps": [ ... ]
+    "indicators.0.data.no_data": false,
+    "indicators.0.data.deleted_data": false,
+    "indicators.0.data.saturation": 0.9575133534830439,
+    "indicators.0.data.growth": 0.042486646516956106,
     "indicators.1.metadata.name": "GHS-POP Comparison Buildings",
-    "indicators.1.metadata.description": "...",
+    "indicators.1.metadata.description": "Comparison between population density and feature density.\nThis can give an estimate if mapping has been completed.\n",
     "indicators.1.layer.name": "Building Count",
-    "indicators.1.layer.description": "...",
-    "indicators.1.result.timestamp_oqt": "...",
-    "indicators.1.result.timestamp_osm": "...",
+    "indicators.1.layer.description": "All buildings as defined by all objects tagged with 'building=*'.\n",
+    "indicators.1.result.timestamp_oqt": "2021-10-05T09:33:30.671060+00:00",
+    "indicators.1.result.timestamp_osm": "2021-09-26T20:00:00+00:00",
     "indicators.1.result.label": "green",
     "indicators.1.result.value": 1,
     "indicators.1.result.description": "...",
-    "indicators.1.result.svg": "..."
-    "indicators.1.result.data": "...",
-    "indicators.1.data.pop_count": "...",
-    "indicators.1.data.area": "...",
-    "indicators.1.data.pop_count_per_sqkm": "...",
-    "indicators.1.data.feature_count": "...",
-    "indicators.1.data.feature_count_per_sqkm": "..."
+    "indicators.1.result.svg": "...",
+    "indicators.1.data.pop_count": 533351.7174390131,
+    "indicators.1.data.area": 70.29342423663759,
+    "indicators.1.data.pop_count_per_sqkm": 7587.5051362347085,
+    "indicators.1.data.feature_count": 69993,
+    "indicators.1.data.feature_count_per_sqkm": 995.7261402485354
   }
 }
 ```
diff --git a/workers/ohsome_quality_analyst/__init__.py b/workers/ohsome_quality_analyst/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.5.1"
+__version__ = "0.6.0"
 __title__ = "ohsome quality analyst"
 __description__ = "Intrinsic and extrinsic data quality metrics for OpenStreetMap data."
 __author__ = "ohsome team"

diff --git a/workers/pyproject.toml b/workers/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ohsome_quality_analyst"
-version = "0.5.1"
+version = "0.6.0"
 description = "Intrinsic and extrinsic data quality metrics for OpenStreetMap data."
 authors = ["ohsome team <[email protected]>"]
 homepage = "https://oqt.ohsome.org"

diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_api_indicator.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_api_indicator.json
@@ -20,7 +20,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "2529"

diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_api_indicator_geojson_io.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_api_indicator_geojson_io.json
@@ -20,7 +20,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "427"
@@ -102,7 +102,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "427"
@@ -184,7 +184,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1350"
@@ -266,7 +266,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1438"
@@ -348,7 +348,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1350"
@@ -430,7 +430,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1438"

diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_api_report.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_api_report.json
@@ -20,7 +20,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "2554"

diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_api_report_geojson_io.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_api_report_geojson_io.json
@@ -20,7 +20,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "452"
@@ -102,7 +102,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "427"
@@ -184,7 +184,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "452"
@@ -266,7 +266,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "427"
@@ -348,7 +348,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1375"
@@ -430,7 +430,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1375"
@@ -512,7 +512,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1350"
@@ -594,7 +594,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1463"
@@ -676,7 +676,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1438"
@@ -758,7 +758,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1375"
@@ -840,7 +840,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1350"
@@ -922,7 +922,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1463"
@@ -1004,7 +1004,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "1438"

diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_cli.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_cli.json
@@ -20,7 +20,7 @@
                         "keep-alive"
                     ],
                     "user-agent": [
-                        "ohsome-quality-analyst/0.5.1"
+                        "ohsome-quality-analyst/0.6.0"
                     ],
                     "content-length": [
                         "2529"