open source Python modules for the IBM PAIRS Geoscope platform
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ibmpairs-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | faf289eeadea31042d03000e70a2f00bb99a6e09432be3312983d9c429814db6 |
|
MD5 | 9c4b1f10048b2dec4bec5684c5bd39ce |
|
BLAKE2b-256 | 331f7b505060900cc8cb5c3ba7a98b7a76b7b62c1ec9adb29208ddeba42eda1a |