This repository provides an interface to the IBM EI: Geospatial APIs component: IBM EI: Geospatial APIs.

E.g. the query module in the subdirectory ibmpairs serves as a wrapper employing the IBM EI: Geospatial APIs served through the RESTful host reachable via https://api.ibm.com/geospatial/run/na/core/v3/.

Sample applications that use ibmpairs can be located in the Environmental-Intelligence project.

If you like to contribute, please read CONTRIBUTING.md first. A list of maintainers is recorded in MAINTAINERS.md.

If you have installed the Python package manager PIP, simply run

pip install --user ibmpairs

Then you can import the IBM EI: Geospatial APIs SDK wrapper modules e.g.:

import ibmpairs.client as client
import ibmpairs.query as query

See the documentation here and try our tutorials.

A self-contained environment can be built with Docker using

git clone https://github.com/ibm/ibmpairs
cd ibmpairs
make docker-build

then run using:

make docker-run

the environment can then be accessed from the following url:

http://localhost:18380

Alternatively you can execute these steps without Make using:

git clone https://github.com/ibm/ibmpairs
cd ibmpairs
docker build -t ibmpairs .

to build and

docker run \
    -dit \
    -p 18380:18380 \
    --name ibmpairs \
    ibmpairs:latest

or:

docker-compose up ibmpairs

to run.