ibmpairs 3.0.6

open source Python modules for the IBM PAIRS Geoscope platform

IBM Environmental Intelligence Suite (EIS): Geospatial Analytics open source modules

This repository provides an interface to the geo-spatial big data platform IBM EIS: Geospatial Analytics.

E.g. the query module in the subdirectory ibmpairs serves as a wrapper employing the IBM EIS: Geospatial Analytics core RESTful API served through the host reachable via https://pairs.res.ibm.com.

General Notes

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

Installation and Usage

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

pip install --user ibmpairs

Then you can import the IBM EIS: Geospatial Analytics API wrapper modules e.g.:

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

Getting started

Simply get your feet wet with the tutorial. Having cloned into the repo, the full API documentation you can generate by Sphinx and the corresponding ReadTheDocs theme by running e.g.

pip install sphinx sphinx_rtd_theme

then make the html pages,

make docs

or without Make

cd docs && make html

then open docs/_build/html/index.html with your favorite browser.

Running in a Docker container

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.