ckanext-geoview - Geospatial viewer for CKAN resources

This extension contains view plugins to display geospatial files and services in CKAN. It contains an OpenLayers based viewer originally developed by Philippe Duchesne and other view plugins that used to be part of ckanext-spatial.

Note: This is a work in progress, if you can help with OpenLayers or Leaflet development, check the Issues section for what needs to be done or add a new issue.

Installation

To install ckanext-geoview on a production site:

1. Activate your CKAN virtual environment, for example:

   source /usr/lib/ckan/default/bin/activate
   

2. Install the ckanext-geoview Python package into your virtual environment:

   pip install ckanext-geoview
   

3. Add the relevant plugins to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini). Check Available plugins to see which ones are available and if they require further configuration.

4. Add the resource_proxy plugin to the ckan.plugins setting.

5. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

   sudo service apache2 reload
   

Development Installation

To install ckanext-geoview for development:

1. Clone the source:

   cd /usr/lib/ckan/default/src
   git clone https://github.com/ckan/ckanext-geoview.git
   

2. Activate your CKAN virtual environment, for example:

   source /usr/lib/ckan/default/bin/activate
   

3. Install the ckanext-geoview Python package into your python virtual environment:

   cd ckanext-geoview
   python setup.py develop
   

4. Continue with the main installation instructions above (step 3 onwards).

Available plugins

• OpenLayers Viewer
• Leaflet GeoJSON Viewer
• Leaflet WMTS Viewer
• Leaflet ESRI Shapefile Viewer

OpenLayers Viewer

The OpenLayers viewer provides access to different geospatial formats and services:

To enable it, add geo_view to your ckan.plugins setting. (use geo_preview if you are using CKAN < 2.3):

ckan.plugins = ... resource_proxy geo_view

On CKAN >= 2.3, if you want the geospatial views to be created by default, add the plugin to the following setting:

ckan.views.default_views = ... geo_view

The formats and services supported are:

Type	Resource format (*)
Web Map Service (WMS)	wms
Web Feature Service (WFS)	wfs
GeoJSON	geojson
GML	gml
KML	kml
ArcGIS REST API	arcgis_rest
Google Fusion Tables	gft

(*) Resource formats are case insensitive

Support varies across formats, so you might want to deactivate the ones you are not interested in. To choose which formats to display, set the following configuration option:

ckanext.geoview.ol_viewer.formats = wms kml

To render Google Fusion Tables resources, a Google API Key must be provided in the ini file:

ckanext.geoview.gapi_key = <API Key here>

This key must be granted Fusion Tables permissions. More information on obtaining such a key can be found at https://developers.google.com/fusiontables/docs/v1/using#APIKey.

All configuration options relating to the OpenLayers viewer (ie those prefixed with ckanext.geoview.ol_viewer.*) are passed to the JavaScript module, where they are accessible on the options.ol_config object:

this.ckan.module('olpreview', function (jQuery, _) {

    // ...

    _onReady: function () {


        console.log(this.options.ol_config)

    }

    // ...

}

Other available configuration options are:

• ckanext.geoview.ol_viewer.hide_overlays: if set to True, overlays won't be visible by default (only the base layer)
• ckanext.geoview.ol_viewer.default_feature_hoveron: if set to True, feature data popup will be displayed when hovering on

Each instance of a view has the following configuration options that can override the global configuration :

• feature_hoveron: if set to True, feature data popup will be displayed when hovering on
• feature_style: JSON representation of an OpenLayers style, as accepted by the StyleMap constructor

Leaflet GeoJSON Viewer

Note: This plugin used to be part of ckanext-spatial.

The Leaflet GeoJSON viewer will render GeoJSON files on a map and add a popup showing the features properties, for those resources that have a geojson format.

To enable it, add geojson_view to your ckan.plugins setting. (use geojson_preview if you are using CKAN < 2.3):

ckan.plugins = ... resource_proxy geojson_view

On CKAN >= 2.3, if you want the views to be created by default on all GeoJSON files, add the plugin to the following setting:

ckan.views.default_views = ... geojson_view

Leaflet WMTS Viewer

The Leaflet WMTS viewer will render WMTS (Web Map Tile Service) layers on a map for those resources that have a wmts format.

To enable it, add wmts_view to your ckan.plugins setting. (use wmts_preview if you are using CKAN < 2.3):

ckan.plugins = ... resource_proxy wmts_view

On CKAN >= 2.3, if you want the views to be created by default on all WMTS resources, add the plugin to the following setting:

ckan.views.default_views = ... wmts_view

Leaflet ESRI Shapefile Viewer

The Leaflet Shapefile viewer will render ESRI Shapfiles (A ZIP archive contains the .shp, .shx, .dbf, and .prj files) on a map and add a popup showing the features properties, for those resources that have a shp format.

To enable it, add shp_view to your ckan.plugins setting. (use shp_preview if you are using CKAN < 2.3):

ckan.plugins = ... resource_proxy shp_view

On CKAN >= 2.3, if you want the views to be created by default on all Shapefiles, add the plugin to the following setting:

ckan.views.default_views = ... shp_view

The projection information (EPSG code, e.g., 4326 and 3857) will be loaded if there is a .prj file provided. You can also add a new field named 'resource_crs' in your custom resource fields or the following configuration option (The loading order is: .prj file, 'resource_crs' field, option and EPSG:4326/WGS84):

ckanext.geoview.shp_viewer.srid = 4326

The encoding of the shapefile can be defined by a custom field named 'encoding' in the metadata of the dataset or the following configuration option (The loading order is: 'encoding' field, option and UTF-8):

ckanext.geoview.shp_viewer.encoding = UTF-8

Common base layers for Map Widgets

The geospatial view plugins support the same base map configurations than the ckanext-spatial widgets.

Check the following page to learn how to choose a different base map layer (Stamen, MapBox or custom):

http://docs.ckan.org/projects/ckanext-spatial/en/latest/map-widgets.html

Registering ckanext-geoview on PyPI

ckanext-geoview should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-geoview. If that link doesn't work, then you can register the project on PyPI for the first time by following these steps:

1. Create a source distribution of the project:

   python setup.py sdist
   

2. Register the project:

   python setup.py register
   

3. Upload the source distribution to PyPI:

   python setup.py sdist upload
   

4. Tag the first release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:

   git tag 0.0.1
   git push --tags
   

Releasing a new version of ckanext-geoview

ckanext-geoview is availabe on PyPI as https://pypi.python.org/pypi/ckanext-geoview. To publish a new version to PyPI follow these steps:

1. Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.

2. Create a source distribution of the new version:

   python setup.py sdist
   

3. Upload the source distribution to PyPI:

   python setup.py sdist upload
   

4. Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.2 then do:

   git tag 0.0.2
   git push --tags