diff --git a/CHANGELOG.md b/CHANGELOG.md index cd6668fb4..e8dc5c288 100644 --- 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 index e004e9814..a38a14ec7 100644 --- a/docs/api.md +++ b/docs/api.md @@ -6,7 +6,7 @@ ```txt { - "apiVersion": "0.5.1", + "apiVersion": "0.6.0", "attribution": { "text": "© OpenStreetMap contributors", "url": "https://ohsome.org/copyrights" @@ -14,25 +14,24 @@ "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,7 +41,7 @@ ```txt { - "apiVersion": "0.5.1", + "apiVersion": "0.6.0", "attribution": { "text": "© OpenStreetMap contributors", "url": "https://ohsome.org/copyrights" @@ -50,45 +49,47 @@ "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 index 00f3f210a..2dbe6cb0f 100644 --- 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 index 1cf68c9ee..efc832fc8 100644 --- 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 "] 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 index 0b3c2ab99..647d6f908 100644 --- 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 index 22802e453..3dc444f83 100644 --- 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 index 7da4f4eb9..809ef42d2 100644 --- 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 index 7e5bb6682..315b05c1b 100644 --- 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 index 6619bff0f..574670b7d 100644 --- 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" diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_cli_geojson_io.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_cli_geojson_io.json index a45d0ea04..2d86a7fa3 100644 --- a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_cli_geojson_io.json +++ b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_cli_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": [ "1350" @@ -102,7 +102,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "1438" @@ -184,7 +184,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "427" @@ -266,7 +266,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "1375" @@ -348,7 +348,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "1463" @@ -430,7 +430,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "452" diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_geodatabase.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_geodatabase.json index fa65b2cdf..8563de61b 100644 --- a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_geodatabase.json +++ b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_geodatabase.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_indicator_ghs_pop_comparison_buildings.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_ghs_pop_comparison_buildings.json index c5b722753..01bedaaaa 100644 --- a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_ghs_pop_comparison_buildings.json +++ b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_ghs_pop_comparison_buildings.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_indicator_last_edit.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_last_edit.json index 269015135..24c149a1b 100644 --- a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_last_edit.json +++ b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_last_edit.json @@ -20,7 +20,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ] } }, @@ -96,7 +96,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "2642" @@ -178,7 +178,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "2613" @@ -260,7 +260,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "481" @@ -342,7 +342,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "452" diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_mapping_saturation.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_mapping_saturation.json index 2fd271835..cd603ce31 100644 --- a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_mapping_saturation.json +++ b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_mapping_saturation.json @@ -20,7 +20,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "2638" @@ -102,7 +102,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "465" @@ -184,7 +184,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "2554" @@ -266,7 +266,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "1788" diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_poi_density.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_poi_density.json index 404b8c213..bcf2a65aa 100644 --- a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_poi_density.json +++ b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_poi_density.json @@ -20,7 +20,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "731" diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_tags_ratio.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_tags_ratio.json index 5faa01edb..363af96d3 100644 --- a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_tags_ratio.json +++ b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_indicator_tags_ratio.json @@ -20,7 +20,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "2906" @@ -102,7 +102,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "817" diff --git a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_oqt.json b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_oqt.json index e3b3691e0..29a4fd9ab 100644 --- a/workers/tests/integrationtests/fixtures/vcr_cassettes/test_oqt.json +++ b/workers/tests/integrationtests/fixtures/vcr_cassettes/test_oqt.json @@ -20,7 +20,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "2613" @@ -102,7 +102,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "2529" @@ -184,7 +184,7 @@ "keep-alive" ], "user-agent": [ - "ohsome-quality-analyst/0.5.1" + "ohsome-quality-analyst/0.6.0" ], "content-length": [ "2554"