attribute-completeness: attribute parameter is renamed to attributes and is now a list of attributes (#819 )
fix inconsistency in docker image tags
New Topics and Project for UNICEF education access project have been added (#832 )
fix: invalid example GeoJSON in swagger (#831 )
fix: global coverage is now returned correctly (#821 )
attribute-completeness: no figure creation if quality could not be calculated (#829 )
report endpoint: has been deleted (#818 )
attribute-completeness: new topic-specific attributes have been added (#826 )
a new regression test suite has been added to support safer deployments of new versions (#820 )
refactor(indicators): separate templates from metadata and merge all metadata files (#673 )
use Pydantic model from the geojson-pydantic library as request model for bpolys (#824 )
attribute-completeness: add workaround for attribute_key to use indicator in dashboard (#800 )
attribute-completeness: add validation for attribute-topic combination (#810 )
attribute-completeness: support for metadata and custom end-point (#810 )
attribute-completeness: improve generation of openAPI documentation (#810 )
road-comparison: bar for not covered roads is now shown in the plot (#798 )
attribute-completeness: fix bugs in result figure (#800 )
road-comparison: change color of bar to grey (#798 )
style: run ruff after version upgrade (#806 )
build: bump ruff version (#806 )
remove support for raster data from implementation and docs (#815 )
major-roads-length: rename to roads and change filter to highway=* and type:way (#786 )
road-comparison: add new indicator which compares OSM roads with a reference dataset ([#778, #787, #788])
building-comparison: support comparison with multiple datasets (#768 )
building-comparison: improve figure and result description by adding more information ([#777, #789])
build: update dependencies (rpy2 and fastapi) (#775 )
update dependencies (#785 )
test: use Approval Tests (#789 )
building-comparison: improve performance of request to database (#790 )
api: add inverse parameter to coverage endpoint (#762 )
building-comparison: add caching of requests made to the database for EUBUCCO buildings (#754 )
building-comparison: add indicator to the list of core indicators and as such make it available on the ohsome Dashboard (#765 )
fix(building-comparison): Use psycopg AsyncConnection. Database connection was synchronous. (ba279b2 )
building-comparison: is calculated for coverage area only (#739 )
building-comparison: result description now shows correct coverage percentage (#739 )
mapping-saturation: estimated total line is now always plotted, f it is not more than five times as large as the highest value (#723 )
building-comparison: AOI is now clipped to the coverage area (#739 )
mapping-saturation: add hover info to estimated total data line (#723 )
building-comparison: now has link to reference datasets (#741 )
building-comparison: added publication date of reference dataset and OSM Timestamp([#750])
building-comparison: no quality estimation for areas with strong difference to reference data (#739 )
test(db): add missing mock for getting coverage from database in tests (#739 )
building-comparison: request EUBUCCO database is now much faster (#743 )
crs validation now covers all valid cases (#721 )
feat(figures): colors based on semantic UI CSS (#591 )
feat(building-comparison): add comparison indicator (#718 )
feat(api): add endpoint to retrieve coverage (#718 )
feat(db): query building area and coverage from EUBUCCO (#718 )
refactor: rename "ohsome quality analyst" (OQT) to "ohsome quality API" (oqapi) (#685 )
This release includes a well specified API and two core indicators available through the ohsome dashboard .
api: remove dataset, featureId and fidField parameter (#634 )
api: computing mapping-saturation indicator for given data is now a separate (hidden) endpoint (#642 )
cli: remove CLI (#634 )
api: remove include_svg, include_html include_data and flatten parameter (#644 )
api: only accept FeatureCollection as bpolys parameter (#650 )
api: add includeFigure parameter to /indicators endpoint (#659 )
api: add indicator response models (#670 )
style: use ruff instead flake8 and isort (#630 )
split 'endpoint' parameter of topics to endpoint and aggregation_type (#600 )
mapping-saturation: y-axis now shows the aggregation type used (#611 )
build(db): refactor database setup (#633 )
refactor: calculate geom area with pyproj instead of PostGIS (#639 )
currentness: improve plot and description (#589 )
refactor: remove separate workers directory (#647 )
build: tidy up docker (and jenkins) setup (#647 )
refactor(api): clean-up and rename request models (#649 )
refactor(api): move openapi param example to model (#649 )
currentness: results with low contributions are now labeled undefined (#643 )
refactor(api): exclude reports endpoint from schema (#656 )
feat(indicator): add as_dict method (#653 )
refactor(oqt/api): move geojson creation to api (#653 )
build: bump fastapi and pydantic major version (#669 )
currentness: overhaul currentness indicator #668
based on monthly interval instead of yearly (#668 )
result class determination based on share of three bins instead of median (#668 )
now uses topic specific thresholds for bin creation (#668 )
plot now shows relative and absolute contributions (#668 )
further improvements to description and plot (#668 )
using a geojson with wrong projection now throws specific error (#667 )
mapping-saturation: now shows the estimated total data in the plot (#658 )
change JSON keys in request and response models from snake case to:
(1) hyphen case for identifiers such as indicator, report and topic keys (#398 )
(2) camel case for other keys (#603 , #625 )
discontinue support GeoJSON Geometry as value for bpolys parameters (#554 )
rename API parameter layerKey and layer to topic (#501 )
rename TagsRatio indicator to attribute-completeness (#500 )
rename PoiDensity indicator to density (#544 )
remove GHS POP Comparison indicators: ghs_pop_comparison_buildings and ghs_pop_comparison_roads (#515 )
remove JRC related layers and report jrc_requirements (#503 )
remove GET request for indicators and reports (#516 )
remove API endpoints:
/indicator and /report (#554 )/indicators, /reports, /datasets and /fid-fields (#554 )/regions (#583 )
requests to the API endpoint /indicators for a custom layer/topic need an additional field key of type string (#517 )
homogenize API response schema for errors (#562 )
response of /indicators is always a FeatureCollections (#598 )
remove all CLI commands except commands for creating all indicators for a given dataset (#556 )
remove website from repository (#578 )
sketch-map-fitness: use landmarks instead of poi topic (#544 )
mapping-saturation: add missing edge case detection for too few data points (#512 )
currentness: fix wrong count of contributions due to multiple requests (#535 )
currentness: exclude deletions when requesting contributions (#535 )
currentness: aggregate on an annual basis instead of per calendar year (#535 )
tidy up and fix filters of core topic definitions (#520 )
doctors: use correct filter (#540 )
landmarks: add density indicator to landmarks topic (#544 )
add project attribute to indicators, reports and topics (#504 , #563 , #601 )
add qualityDimensions attribute to indicators (#561 )
topic is now a pydantic model instead of a dataclass (#517 )
substitute indicator result figure creation with plotly instead of matplotlib (#499 , #535 , #536 , #544 , #551 , #552 , #559 )
add /indicators/{key} and /reports/{key} endpoints (#554 )
support JSON in addition to GeoJSON responses (#582 , #627 )
add /metadata/topic endpoint (#519 )
add /metadata/indicators endpoint (#533 )
add /metadata/reports endpoint (#545 )
add /metadata endpoint (#545 , #601 )
mapping-saturation: disable size limit (#498 )
build(docker): overhaul docker compose setup (#483 )
build: fix pre-commit hooks (#482 )
build: update dependencies (#481 , #488 , #531 , #576 )
api: remove unnecessary newlines from API output and internal definitions (#529 )
api: serve Swagger UI files not via CDN (#581 , #593 , #605 )
api: fix attribution URL path (#543 )
refactor(db): remove artifacts as well as old init scripts and restructure directories (#388 )
refactor(topic): rename layer to topic (#521 )
refactor(topic): move base/topic.py to topics/models.py and layer_defintions.yaml to topics/presets.yaml (#523 )
refactor: factor out validators from pydantic models to validators module (#554 )
refactor: add validation exceptions (#554 )
refactor: move base classes to related modules (#524 )
refactor: move topic-indicator-combinations to topic definition (#528 )
tests(vcr): don't record local requests and change cassettes directory structure (#579 )
use new endpoints /indicators/{key} and /reports/{key} for computing indicators and reports
use new endpoint /metadata to retrieve metadata
change JSON keys in request and response models:
(1) hyphen case for identifiers such as indicator, report and topic keys (#398 )
(2) camel case for other keys (#603 )
for requests to the API endpoint /indicators/{key} for a custom topic add another field key of type string (#517 ):
{
"bpolys" : {... },
"topic" : {
"key" : " my-key" "name" : " my-name" "description" : " my-description" "data" : {... }
}
}
change parsing of error messages to work with following schema (#562 ):
{
"apiVersion" : " __version__" "type" : " exception.name" "detail" : [
{
"msg" : " exception.message"
type
old
new
API parameter
layerKeytopic
indicator key
TagsRatioattribute-completeness
indicator key
PoiDensitydensity
indicator key
CamelCase hyphen-case
report key
CamelCase hyphen-case
topic key
snake_case hyphen-case
currentness: add appropriate timeout for ohsome API metadata requests (#537 )
mapping-saturation: allow result value above 100% (#479 )
fix wrong ratio_filter in layer building_count (#457 )
Reports with only undefined indicators are now labeled undefined too (#456 )
fix broken link to doc in README (#466 )
FoodRelatedReport now uses red & undefined blocking (#468 )
add new layers fire_station_count and hospitals_count (#442 )
Add new layers related to food environment (#455 )
Add new report FoodRelatedReport (#455 )
add new layers schools, kindergartens, clinics, doctors, bus_stops, tram_stops, subway_stations, marketsplaces. parks, forests, fitness_centres and supermarkets (#444 )
remove upper Python version requirement limitation. Minimum Python version is 3.8. (#465 )
update dependencies (#465 )
Fix patch colorization of Currentness indicator plot (#432 )
Rename duplicated layer name Major Roads to Major Roads Count and Major Roads Length. Results are stored in database using the layer name as part of the primary key. (#438 )
Reports take result class of indicators into account (#372 #369 )
Substitute result values of reports by introducing a result class value (#372 )
Change default data directory to be in workers directory (#312 )
Move example rasters of data directory to test fixtures (#312 )
Rename layer ideal_vgi_infrastructure to infrastructure_lines (#416 #426 )
Improve Currentness indicator (#274 )
Add new report MultilevelCurrentness (#403 )
Add MapAction priority countries to database (#427 #428 )
Make inclusion of indicator data in response optional (#370 )
Per default properties of the GeoJSON response are not flat (#375 )
Remove project specific reports JrcRequirements, SketchmapFitness, and MapActionPoc from the website (#382 )
Rename API query parameter layerName to layerKey and API endpoint listLayerNames to listLayerKeys (#376 )
Rename endpoints for listing of indicator, report, layer, dataset and fid-field names (#397 )
Rename environment variable OHSOME_API to OQT_OHSOME_API (#255 )
Fix indicator description field of GeoJSON properties (#396 )
Add new representative report RoadReport (#357 )
Add new representative report BuildingReport (#356 )
Add ratio filter to building_count layer (#356 )
Configure OQT using files or environment variables (#255 )
Generalize result values of all Indicators by introducing a result class value (#369 )
Remove unused report RemoteMappingLevelOne (#380 )
Substitute Simple Report with a Report named Minimal for testing purposes (#342 #385 )
Add a minimal Indicator for testing purposes (#383 )
Remove database scripts (#392 )
fix: building completeness figure (#410 )
Reports JrcRequirements, SketchmapFitness, and MapActionPoc are not accessibly via the website anymore. If you want to access those reports please use the API.
To continue to retrieve the properties of the GeoJSON API response as flat list, you need to set the API request parameter flatten to True (#375 )
To continue to retrieve additional data of an Indicator or Report provided in an API response, you need to set the API request parameter include_data to True (#370 )
Rename environment variable OHSOME_API OQT_OHSOME_API (#255 )
Make sure to rename the API query parameter layerName to layerKey and API endpoint listLayerNames to listLayerKeys (#376 )
If you run your own database, please delete the result table before upgrading (#369 )
Rename endpoints (#397 ):
old
new
indicatorLayerCombinationsindicator-layer-combinations
indicatorNamesindicators
datasetNamesdatasets
layerNameslayers
reportNamesreports
fidFieldsfid-fields
Add new report MulilevelMappingSaturation (#379 )
Add missing error handling of RasterDatasetUndefinedError and RasterDatasetNotFoundError to the API (#298 )
Fix missing HTML generation for Indicators calculated from scratch (bpolys parameter) (#345 )
Fix semaphore instantiation outside of event-loop (#346 )
Add support for groupBy/boundary queries to the ohsome API client (#272 )
Add flatten parameter to API request. Make flatten of GeoJSON properties of Indicators and Reports optional (#303 )
Make calculation of an Indicator for a FeatureCollection or for a Report asynchronous (#307 )
Add new Indicator which predicts the building area of the AOI using a trained Random Forest Regressor (#265 )
Add support for groupBy/boundary queries to the ohsome API client (#272 )
Improve documentation and examples of the API (#299 )
Factor out template logic to own module (#302 )
Remove artifacts of database setup for GHSL raster datasets (#310 )
Add hex-cells at zoom level 12 for Africa to the database (#314 )
Disable size limit on input AOI if OSM data is provided through a request with a custom Layer object (#330 )
Add new parameter includeHtml to the API endpoints /indicator and /report to include a HTML snippets with the results in the response (#242 )
Add new parameter layer containing name, description and data fields to the API endpoint indicator. Only available for POST requests. This enables to compute indicators for given data. (#245 )
Use (rasterstats#227 )
Utilize singledispatch for create_indicator function of the oqt module (#239 )
Add landmarks layer #246 )
Add SHDI to database and add functionality to get SHDI for an AOI by intersection using SQL (#266 )
Support any dataset, not just "regions" for CLI function create_all_indicators (#254 )
Fix concurrent execution of CLI function create_all_indicators using async and semaphores (#254 )
Support choosing a single indicator and/or single layer for CLI command create_all_indicators (#254 )
Indicators based on GHS-POP use raster file stored on disk instead of raster in the database (#276 )
Remove "IDEAL-VGI Land Use and Land Cover" as valid layer for the Mapping Saturation indicator (#221 )
Disable support of the parameter bpolys for GET requests to the API (#223 )
Rewrite of the Mapping Saturation indicator to use statistical models from the R language (#170 )
Improve API Swagger interface by adding more examples and better documentation (#237 )
Make pydantic data models more modular (#237 )
Use scipy#170 )
ideal_vgi_lulc is not a valid layer for the Mapping Saturation indicator anymore (#221 )For requests to the /indicator or /report endpoints of the API for a custom AOI (usage of the bpolys parameter): use the POST method (#223 )
R (≥ 4.0) needs to be available on the system on which OQT runs (#170 )
Change API Path parameter name to be a Query parameter instead of a Path parameter (#190 )
Change type of API parameter bpolys for POST requests to JSON (dict) instead of string (#204 )
Add parameter to retrieve API response without the figure as svg string in the result. Default to not exclude the figure. (#137 )
Rename LastEdit indicator to Currentness (#178 )
API: Change media type of GeoJSON response (#199 )
Validate indicator-layer combination with pydantic (#190 )
Improve API response when an error occurs by including information about the cause (#186 )
Add parameter to get API response without svg string in the result (#137 )
Extend time range for the Currentness indicator (#178 )
Update requests for /indicator and /report endpoints. name is now a Query parameter. (#190 )
E.g. /indicator/GhsPopComparisonBuilding -> indicator?name=GhsPopComparisonBuilding
Update bpolys parameter of POST requests to be a GeoJSON object instead of a string (#204 )
To retrieve a figure for the result as SVG string from the /indicator and /report endpoints set the request parameter 'includeSvg' to True (#137 )
Update requests for the indicator Last Edit which is now named Currentness (#178 )
E.g. /indicator?name=Currentness
Save indicator as GeoJSON Feature to DB (#149 )
Extend database schema with one additional attribute feature of type JSON
API endpoint /regions responds with an array of names and ids (default) or a GeoJSON if parameter asGeoJSON=True is set (#171 , #195 )
Add API-endpoints to list indicators, reports, layers, datasets and feature id fields (#106 )
Add request models, data validation and documentation to the API with the pydantic#102 )
Added documentation on “How to add a layer definitions” (#141 )
Use concurrency when creating all indicators (#153 )
Add and improve tests for API (#168 )
Add test cases covering the content of GeoJSON properties.
Improve API response schemata by using less logic to create the schemata.
Add list indicator/layer combinations for API and CLI(#99 )
Load indicator from DB will also load its data attributes (#179 )
Change output of CLI command list-regions to a pretty printed table of names and identifies (#65 , #196 )
If you set up your own database you will need to rebuild the database or delete the results table (DROP TABLE results;).
If you used the API endpoint /regions be aware of the changed output format (#171 , #195 ). If you want to retrieve a GeoJSON use the parameter asGeoJSON=True.
Apply breaking changes from 0.5.0 (#100 , #130 ) to the webclient (#132 )
API response is a valid GeoJSON and equates to the CLI file output (#100 , #130 )
API output schema changes completely to a GeoJSON output
Indicator and report data and results are written in a flat hierarchy to the properties' field of the GeoJSON
Example responses can be found in the API documentation
Fix error raised by the geojson library while serializing JSON that includes NaN values (#112 )
Fix error on slow mobiles where the dependencies would not be loaded correctly (#122 )
Fix error where region selection was inconsistent on mobile (#122 )
Fix Mapping Saturation indicator bug (#123 )
Added checks for NaN-values in variable inits5curves, which lead to false error-calculation.
FeatureCollection with multiple Features allowed as input to the API (#100 )
Add new layer definitions for the IdealVGI project (#134 )
Set proper User Agent for requests to the ohsome API (#62 )
Set log level matplotlib fontmanager to INFO (#90 )
Make VCR mode configurable (#95 )
Minor improvements to the metadata and docstrings of indicators (#110 )
Change return type from bool to None for indicator for functions: preprocess, calculate, create_figure (#96 )
Implement mapping of custom feature id to default (unique) feature id (#83 )
Add osm-timestamps to indicators (#101 )
Add timezone to oqt-timestamp (#101 )
Update UML Component Diagram (#136 )
Change type of attribute bpolys to be GeoJSON.Feature (#69 )
Add option to select different datasets and fid fields as input to OQT (#4 )
Return a GeoJSON when computing an indicator from the CLI using a dataset and FID (#57 )
Add check and custom exception for an invalid indicator layer combination during initialization of indicator objects (#28 )
Add pre-commit check for PEP 8 conform names by adding the pep8-naming package as development dependency (#40 )
Raise exceptions in the ohsome client instead of returning None in case of a failed ohsome API query (#29 )
Rewrite save and load indicator from database logic to use one result table for all indicator results (#37 )
Remove GUF Comparison indicator (#55 )
Implement combine_indicators() as Concrete Method of the Base Class Report (#53 )
Small changes to the Website (#61 )
Change HTML parameters from countryID and topic to id and report (#30 )
Mention API and GitHub on About page (#5 )
On Click to marker now only zooms to polygon instead to fixed value
Update MapAction layers and POC report (#56 )
Simplify CLI option handling by only allowing one option at a time to be added (#54 )
Redefine OQT regions (#26 )
Use ohsome API endpoint /contributions/latest/count for Last Edit indicator (#68 )
Implement as_feature function for indicator and report classes (#86 )
Fix wrong layer name for Map Action Report (#19 )
Database schema changes: Add timestamp to indicator results !125
Database schema changes of the regions table !120
Rename attributes infile to name
Change geometry type from polygon to multipolygon
Add data input and output attributes to indicator !129
Return a GeoJSON when computing an indicator from the CLI !140
Retrieve available regions through API and CLI !120
Performance and Code Quality
Improve report tests by using mocks to avoid querying ohsome API !116
Integrate VCR.py to cache data for tests !133
Database can be setup with available regions for development or with only regions for testing !120
Different validation processes of input geometry for entry points (API and CLI) !119
Add review process description to contributing guidelines !124
Improve documentation !128 !144 !150
Add license: GNU AGPLv3 !134
Update dependencies !139
Tidy up repository !138 !120
Changes to available regions for pre-computed results !120:
Remove fid attribute from GeoJSON Feature object properties and add id attribute to GeoJSON Feature object
Rename test_regions to regions
Extent regions with four countries (#196)
Correct geometry of following duplicated regions: id 2 and id 28
Remove and download regions.geojson instead
Website will use regions.geojson when present. Otherwise, it will use the API endpoint.
Refine pyproject.toml !65
Minor improvements of the documentation !67
Update pre-commit to not make changes !69
Rename uvicorn runner script and integrate it into Docker setup !70
Improve error handling of database authentication module !72
Add force recreate indicator/report option !75
Minor changes to the code structure !77 !79 !83 !90 !93
ohsome API requests are performed asynchronously !80
Use official Python Dockerfile as base Dockerfile for OQT !81
Improve docs structure !91
Bug fixes !92
Improve logging messages #146
Implement new indicator tag_ratio !85
Remove psycopg2-binary and auth.py in favor of asyncpg and client.py !93
Remove database and feature_id attributes from indicator classes !93
Implement async/await for geodatabase !93
Update dependencies #109
Change API response to avoid overriding indicators !108 #203
Put JRC Report on website !107 #189
Change description for Mapping Saturation indicator !63
Add undefined label to GHS_POP !55
Add uvicorn runner for development setup !54
Improve logging !54
Update to poetry 1.0 and update dependencies !51
Fixes Last Edit indicator in cases where it can not be calculated !50
Fix handling of NaN value errors in mapping saturation indicator !48
Fix response to be initialized for every request !47
Improve docs on development setup and testing !45
Force the recreation of all indicator through CLI !38
Development setup of database using Docker !33 !37
Separate integration tests from unit tests #116
Add contribution information on issues, merge requests and changelog !31
Review docs on all parts of OQT - if they are existent/complete/understandable #71
GhsPopComparison: Raster and geometry do not have the same SRID #86
Short and precise documentation on how to set up and how to contribute #46
Define API response format #16
Unresolved merge conflict lines on the about page #82
Wrong filename for figures #78
Store svg string in database and not filepath #79
Clean up API endpoints #51
Wrong ohsome API endpoint in last edit indicator #77
Errors during creation of the mapping saturation indicator for test_regions #72
Specify where metadata about an indicator should be stored #25
Indicator class should have a result, and a metadata attribute #53
Finish work on saturation indicator #50
Move ohsome API related code and definitions to own module #52
Decide on a Project Name #35
Document what is currently working, what is still missing #49