# IBM Environmental Intelligence (EI): Geospatial APIs SDK
[](https://pypi.org/project/ibmpairs/)
This repository provides an interface to the IBM EI: Geospatial APIs component:
[IBM EI: Geospatial APIs](https://www.ibm.com/products/environmental-intelligence).
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/](https://developer.ibm.com/apis/catalog/envintelsuite--ibm-environmental-intelligence).
Sample applications that use `ibmpairs` can be located in the [Environmental-Intelligence](https://github.com/IBM/Environmental-Intelligence/tree/main) project.
# 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 EI: Geospatial APIs SDK wrapper modules e.g.:
```Python
import ibmpairs.client as client
import ibmpairs.query as query
```
# Getting started
See the documentation [here](https://ibm.github.io/ibmpairs/) and try our tutorials.
# 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/c6/be/3fbbd64960764afc6d480334dd8f7fa2015f758f7863b323f268148435eb/ibmpairs-3.1.6.tar.gz",
"platform": null,
"description": "# IBM Environmental Intelligence (EI): Geospatial APIs SDK\n\n[](https://pypi.org/project/ibmpairs/)\n\nThis repository provides an interface to the IBM EI: Geospatial APIs component:\n[IBM EI: Geospatial APIs](https://www.ibm.com/products/environmental-intelligence).\n\nE.g. the `query` module in the subdirectory `ibmpairs` serves as a wrapper employing the IBM EI: \nGeospatial APIs served through the RESTful host reachable via\n[https://api.ibm.com/geospatial/run/na/core/v3/](https://developer.ibm.com/apis/catalog/envintelsuite--ibm-environmental-intelligence).\n\nSample applications that use `ibmpairs` can be located in the [Environmental-Intelligence](https://github.com/IBM/Environmental-Intelligence/tree/main) project.\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 EI: Geospatial APIs SDK wrapper modules e.g.:\n```Python\nimport ibmpairs.client as client\nimport ibmpairs.query as query\n```\n\n\n# Getting started\n\nSee the documentation [here](https://ibm.github.io/ibmpairs/) and try our tutorials.\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.6",
"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": "42fbc159a304254e53c255f287349c5756270194e3df53a8f55d73c7fb1a58c6",
"md5": "4de5c0e9ea305ec7cacfa9e99bad2c8f",
"sha256": "9204c65ec6f173fa771375facffbe1517225bb6018c9a76c6e984df21135a8f0"
},
"downloads": -1,
"filename": "ibmpairs-3.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4de5c0e9ea305ec7cacfa9e99bad2c8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 190788,
"upload_time": "2024-10-09T17:16:24",
"upload_time_iso_8601": "2024-10-09T17:16:24.185219Z",
"url": "https://files.pythonhosted.org/packages/42/fb/c159a304254e53c255f287349c5756270194e3df53a8f55d73c7fb1a58c6/ibmpairs-3.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6be3fbbd64960764afc6d480334dd8f7fa2015f758f7863b323f268148435eb",
"md5": "23efc33a7db2b934e758f3b915e8eecd",
"sha256": "cf1c444cec8f4eccbd491666825865ae16e1c1fa8fb79fc1052a559bba31b5c0"
},
"downloads": -1,
"filename": "ibmpairs-3.1.6.tar.gz",
"has_sig": false,
"md5_digest": "23efc33a7db2b934e758f3b915e8eecd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 187390,
"upload_time": "2024-10-09T17:16:25",
"upload_time_iso_8601": "2024-10-09T17:16:25.561715Z",
"url": "https://files.pythonhosted.org/packages/c6/be/3fbbd64960764afc6d480334dd8f7fa2015f758f7863b323f268148435eb/ibmpairs-3.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 17:16:25",
"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
