IBM PAIRS Geoscope open source modules

This repository provides an interface to the geo-spatial big data platform IBM PAIRS Geoscope.

E.g. the module in the subdirectory paw serves as a wrapper employing the IBM PAIRS core RESTful API served through the host reachable via https://pairs.res.ibm.com to load data into (native) Python data structures.

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

Alternatively,

conda install -c conda-forge ibmpairs

works as well. Then you import the IBM PAIRS API wrapper via:

from ibmpairs import paw

Note: If you need a bleeding-edge, potentially instable development version you can also run

pip install --user git+https://github.com/ibm/ibmpairs@develop

Getting started

Simply get your feet wet with the tutorial. Having cloned into the repo, the full API documentation you can generate by running

cd docs && make html

to open docs/_build/html/index.html with your favorite browser, provided you have installed Sphinx and the corresponding ReadTheDocs theme by running e.g.

pip install sphinx sphinx_rtd_theme

Running in a Docker container

A self-contained environment can be built with Docker using

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

and launched via

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

or, instead of the above, simply docker-compose up ibmpairs such that you can type into your browser

http://localhost:18380