seenaomi / hhypermap

HHypermap (Harvard Hypermap) Registry is an application that manages OWS, Esri REST, and other types of map service harvesting, and maintains uptime statistics for services and layers. HHypermap Registry will publish to HHypermap Search (based on Lucene) which provides a fast search and visualization environment for spatio-temporal materials.

HHypermap Registry

Introduction

HHypermap (Harvard Hypermap) Registry is a platform that manages OWS, Esri REST, and other types of map service harvesting, and orchestration and maintains uptime statistics for services and layers. Where possible, layers will be cached by MapProxy. It is anticipated that other types of OGC service such as WFS, WCS, WPS, as well as flavors of Esri REST and other web-GIS protocols will eventually be included. The platform is initially being developed to collect and organize map services for Harvard WorldMap, but there is no dependency on WorldMap. HHypermap Registry publishes to HHypermap Search (based on Lucene) which provides a fast search and visualization environment for spatio-temporal materials. The initial funding for HHypermap Registry came from a grant to the Center for Geographic Analysis from the National Endowment for the Humanities.

A description of the HHypermap API is here: http://hh.worldmap.harvard.edu/registry/api/docs/. The documentation for the API still needs to be fleshed out with examples for how to get a heatmap, what the values mean, how to get a temporal histogram, how to search using special characters like *, etc.

Installation

Running Hypermap on Docker

Easiest way to have an HHypermap instance up and running is to use Docker.

git clone [email protected]:cga-harvard/HHypermap.git
cd HHypermap
make build
make up
make sync
make logs

Wait for the instance to be provisioned (about 3/4 minutes).

Then connect to: http://localhost:8000 and your instance should be up and running.

You can edit the files with your IDE from your host, as the directory /code on the guest is synced with your host.

To run unit tests:

make test

To debug Django, this is what it can be done:

docker-compose stop django
docker-compose run --service-ports django

Then add some breakpoint - import ipdb;ipdb.set_trace() - and happy debugging!

To run the shell or other django commands::

docker exec -it hypermap_django_run_8 bash
python manage.py shell
python manage.py solr_scheme

Start using Hypermap

Login to the home page, http://localhost:8000. It will be empty. You need to add some endpoints to Hypermap. So go to the administrative interface:

http://localhost:8000/admin/

Go to Endpoint List and add an endpoint list, for example the one included in /data.

After saving, Hypermap should be start harvesting the endpoint.

Harvesting will be performed by the Django server if SKIP_CELERY_TASK = True, otherwise by Celery. Please note that harvesting operations can be time consuming, so it is better to setup a Celery process if possible.