Metadata-Version: 2.1
Name: ibmpairs
Version: 3.1.16
Summary: open source Python modules for the IBM Environmental Intelligence Geospatial APIs platform
Home-page: https://ibm.github.io/ibmpairs/
Author: Environmental Intelligence, IBM Software
Author-email: pairs@us.ibm.com
Maintainer: taylorsteffanj
License: BSD-Clause-3
Project-URL: Documentation, https://ibm.github.io/ibmpairs/
Project-URL: Source, https://github.com/ibm/ibmpairs
Project-URL: Tracker, https://github.com/ibm/ibmpairs/issues
Keywords: IBM Environmental Intelligence Geospatial APIs Geospatial Analytics PAIRS GIS BigGeoData
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: GIS
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.13.3
Requires-Dist: fs>=2.4.16
Requires-Dist: geojson
Requires-Dist: ibm_cos_sdk
Requires-Dist: jsonschema
Requires-Dist: numpy>=1.18.1
Requires-Dist: pandas>=1.0.1
Requires-Dist: Pillow>=12.1.1
Requires-Dist: polling
Requires-Dist: pytz
Requires-Dist: rasterio>=1.4.3
Requires-Dist: Requests>=2.4
Requires-Dist: Shapely
Requires-Dist: tableschema

# IBM Environmental Intelligence (EI): Geospatial APIs SDK

[![PyPI Package](https://badge.fury.io/py/ibmpairs.svg)](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.
