# IBM Environmental Intelligence Suite (EIS): Geospatial Analytics open source modules
[](https://travis-ci.org/IBM/ibmpairs)
[](https://pypi.org/project/ibmpairs/)
This repository provides an interface to the geo-spatial big data platform
[IBM EIS: Geospatial Analytics](https://www.ibm.com/products/environmental-intelligence-suite).
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](https://pairs.res.ibm.com/manual/api-doc/).
# General Notes
If you like to contribute, please read [CONTRIBUTING.md](https://github.com/ibm/ibmpairs/blob/master/CONTRIBUTING.md)
first. A list of maintainers is recorded in [MAINTAINERS.md](https://github.com/ibm/ibmpairs/blob/master/MAINTAINERS.md).
# Installation and Usage
If you have installed the Python package manager [PIP](https://github.com/pypa/pip),
simply run
```Bash
pip install --user ibmpairs
```
Then you can import the IBM EIS: Geospatial Analytics API wrapper modules e.g.:
```Python
import ibmpairs.client as client
import ibmpairs.query as query
```
# Getting started
Simply get your feet wet with the [tutorial](https://github.com/ibm/ibmpairs/blob/master/tutorials/IBM-EIS-Geospatial-Analytics-API-wrapper.ipynb).
Having cloned into the repo, the full API documentation you can generate by [Sphinx](https://www.sphinx-doc.org/) and the corresponding
[ReadTheDocs](https://readthedocs.org/) theme by running e.g.
```Bash
pip install sphinx sphinx_rtd_theme
```
then make the html pages,
```Bash
make docs
```
or without Make
```Bash
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](http://www.docker.com) using
```Bash
git clone https://github.com/ibm/ibmpairs
cd ibmpairs
make docker-build
```
then run using:
```Bash
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:
```Bash
git clone https://github.com/ibm/ibmpairs
cd ibmpairs
docker build -t ibmpairs .
```
to build and
```Bash
docker run \
-dit \
-p 18380:18380 \
--name ibmpairs \
ibmpairs:latest
```
or:
```Bash
docker-compose up ibmpairs
```
to run.
Raw data
{
"_id": null,
"home_page": "https://ibmpairs.mybluemix.net",
"name": "ibmpairs",
"maintainer": "cmalbrec",
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "IBM PAIRS GIS BigGeoData",
"author": "Physical Analytics, IBM Research",
"author_email": "pairs@us.ibm.com",
"download_url": "https://files.pythonhosted.org/packages/58/57/c6dd9cfb4e6d4abfc08162d8d5be7d5f166a65c32e24708e107d8c5d3918/ibmpairs-3.1.1.tar.gz",
"platform": null,
"description": "# IBM Environmental Intelligence Suite (EIS): Geospatial Analytics open source modules\n\n[](https://travis-ci.org/IBM/ibmpairs)\n[](https://pypi.org/project/ibmpairs/)\n\n\nThis repository provides an interface to the geo-spatial big data platform\n[IBM EIS: Geospatial Analytics](https://www.ibm.com/products/environmental-intelligence-suite).\n\nE.g. the `query` module in the subdirectory `ibmpairs` serves as a wrapper employing the IBM EIS: \nGeospatial Analytics core RESTful API served through the host reachable via\n[https://pairs.res.ibm.com](https://pairs.res.ibm.com/manual/api-doc/).\n\n\n# General Notes\n\nIf you like to contribute, please read [CONTRIBUTING.md](https://github.com/ibm/ibmpairs/blob/master/CONTRIBUTING.md)\nfirst. A list of maintainers is recorded in [MAINTAINERS.md](https://github.com/ibm/ibmpairs/blob/master/MAINTAINERS.md).\n\n\n# Installation and Usage\n\nIf you have installed the Python package manager [PIP](https://github.com/pypa/pip),\nsimply run\n```Bash\npip install --user ibmpairs\n```\nThen you can import the IBM EIS: Geospatial Analytics API wrapper modules e.g.:\n```Python\nimport ibmpairs.client as client\nimport ibmpairs.query as query\n```\n\n\n# Getting started\n\nSimply get your feet wet with the [tutorial](https://github.com/ibm/ibmpairs/blob/master/tutorials/IBM-EIS-Geospatial-Analytics-API-wrapper.ipynb).\nHaving cloned into the repo, the full API documentation you can generate by [Sphinx](https://www.sphinx-doc.org/) and the corresponding\n[ReadTheDocs](https://readthedocs.org/) theme by running e.g.\n```Bash\npip install sphinx sphinx_rtd_theme\n```\nthen make the html pages,\n```Bash\nmake docs\n```\nor without Make\n```Bash\ncd docs && make html\n```\nthen open `docs/_build/html/index.html` with your favorite browser.\n\n\n# Running in a Docker container\n\nA self-contained environment can be built with [Docker](http://www.docker.com) using\n```Bash\ngit clone https://github.com/ibm/ibmpairs\ncd ibmpairs\nmake docker-build\n```\nthen run using:\n```Bash\nmake docker-run\n```\nthe environment can then be accessed from the following url:\n```\nhttp://localhost:18380\n```\n\nAlternatively you can execute these steps without Make using:\n```Bash\ngit clone https://github.com/ibm/ibmpairs\ncd ibmpairs\ndocker build -t ibmpairs .\n```\nto build and\n```Bash\ndocker run \\\n -dit \\\n -p 18380:18380 \\\n --name ibmpairs \\\n ibmpairs:latest\n```\nor:\n```Bash\ndocker-compose up ibmpairs\n```\nto run.\n",
"bugtrack_url": null,
"license": "BSD-Clause-3",
"summary": "open source Python modules for the IBM PAIRS Geoscope platform",
"version": "3.1.1",
"project_urls": {
"Documentation": "https://pairs.res.ibm.com/tutorial",
"Homepage": "https://ibmpairs.mybluemix.net",
"Source": "https://github.com/ibm/ibmpairs",
"Tracker": "https://github.com/ibm/ibmpairs/issues"
},
"split_keywords": [
"ibm",
"pairs",
"gis",
"biggeodata"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ceaabc32624f560f21325677c157460200a66e270b3adad7eb11008a9167b377",
"md5": "26a0e8b6f30234dafc26471e68b562f8",
"sha256": "a6923345dbf4c830d7a4483d32cd4ce8735abf5b02838e4e48440f20056536d7"
},
"downloads": -1,
"filename": "ibmpairs-3.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26a0e8b6f30234dafc26471e68b562f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 190509,
"upload_time": "2024-03-28T17:48:36",
"upload_time_iso_8601": "2024-03-28T17:48:36.427796Z",
"url": "https://files.pythonhosted.org/packages/ce/aa/bc32624f560f21325677c157460200a66e270b3adad7eb11008a9167b377/ibmpairs-3.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5857c6dd9cfb4e6d4abfc08162d8d5be7d5f166a65c32e24708e107d8c5d3918",
"md5": "9e3fb1deab2cddf11b965fd77034eecc",
"sha256": "6e6785dee17ecf962cd2b70e86d733dbb15ca72f3b6b964a5519ccee575abb8b"
},
"downloads": -1,
"filename": "ibmpairs-3.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9e3fb1deab2cddf11b965fd77034eecc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 187155,
"upload_time": "2024-03-28T17:48:38",
"upload_time_iso_8601": "2024-03-28T17:48:38.157549Z",
"url": "https://files.pythonhosted.org/packages/58/57/c6dd9cfb4e6d4abfc08162d8d5be7d5f166a65c32e24708e107d8c5d3918/ibmpairs-3.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 17:48:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ibm",
"github_project": "ibmpairs",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ibmpairs"
}
JSON
