Geolocation support

[lnielsen]

Basics

• Serialization:
  • GeoJSON (GeoJSON schema in Zenodo)
• Search:
  • Filter: Bounding box search (see below)
  • Sort: Distance from pin location (old example)
• REST API:
  • Metadata support for locations (metadata reference).
• Deposit form:
  • New widgets for geo fields (needs mockups for how to meaningfully edit location data)

Extensions:

• Import e.g. geonames as a vocabulary to auto-complete from in places etc.

Example of bounding box for records-rest (needs to be translated to records-resources)

def geo_bounding_box_filter(field, type=None):
    """Create a geo bounding box filter.

    :param field: Field name.
    :param type: Method to use (``memory`` or ``indexed``).
    :returns: Function that returns the Geo bounding box query.
    """
    def inner(values):
        # TODO: parse values to ensure they are correct before sending them to
        # ES. top > bottom, numbers ....
        # 5.089416503906251,45.82497145796607,7.012023925781251,46.773730730079414
        values = values[0].split(',')
        if len(values) != 4:
            abort(400, 'Invalid bounds: Require 4 numbers separated by comma.')

        try:
            query = {
                field: {
                    'top_right': {
                        'lat': Decimal(values[3]),
                        'lon': Decimal(values[2]),
                    },
                    'bottom_left': {
                        'lat': Decimal(values[1]),
                        'lon': Decimal(values[0]),
                    }
                }
            }
        except InvalidOperation as e:
            abort(400, 'Invalid number in bounds.')

        if type:
            query['type'] = type
        return Q('geo_bounding_box', **query)
    return inner

Related issues:

• we should integrate the previewer: GeoJSON Previewer invenio-previewer#216
• Deposit: Spatial fields and GeoJson Export format invenio-app-rdm#2176

Use cases

• On top of the classic support of GeoJSON, partners need to support GML. The location field could support an extra property to define the format of the location metadata, so more formats might be supported. CESNET should provide an example of what they need.
• Each location should also support a type or relationType, a vocabulary field to describe the relation between the record and the location. For example, e.g. "collected".