Merge pull request #60 from taylorsteffanj/pages

Release 3.1.3
IBM · Jun 26, 2024 · d8559fa · d8559fa
2 parents bd2988f + c857e84
commit d8559fa
Show file tree

Hide file tree

Showing 151 changed files with 40,111 additions and 616 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 ## Contributing
 
-You are very welcome to contribute to the open source repository of the IBM Environmental Intelligence Suite: Geospatial Analytics python SDK (ibmpairs).
+You are very welcome to contribute to the open source repository of the IBM Environmental Intelligence: Geospatial APIs SDK (ibmpairs).
 To contribute code or documentation, please submit a [pull request](https://github.com/IBM/ibmpairs/pulls).
 
 

diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -1,6 +1,6 @@
 # MAINTAINERS
 
-This project relates to [IBM Environmental Intelligence Suite: Geospatial Analytics](https://www.ibm.com/products/environmental-intelligence-suite) which is maintained
+This project relates to [IBM Environmental Intelligence: Geospatial APIs](https://www.ibm.com/products/environmental-intelligence) which is maintained
 by the groups [*Sustainability Software* at IBM Software, IBM Corp.](https://www.ibm.com/sustainability) & [*Physical Analytics* at IBM Research, IBM Corp.](https://researcher.watson.ibm.com/researcher/view_group.php?id=6566),
 particularly:
 - Steffan J. Taylor

diff --git a/Makefile b/Makefile
@@ -62,7 +62,17 @@ docker-run:
 	@echo 'Running docker container ibmpairs on port 18380'
 	@docker run -dit -p 18380:18380 --name ibmpairs ibmpairs:latest
 
-docs: ## Create local SDK documentation
-docs:
-	@echo 'Building docker container ibmpairs'
-	@cd docs && make html
+doc: ## Create SDK documentation
+doc:
+	@echo 'Creating ibmpairs SDK docs'
+	@rm -rf sphinx/build
+	@rm -rf sphinx/source/tutorials
+	@pip install -r requirements-development.txt
+	@mkdir -p sphinx/source/tutorials
+	@cp -R tutorials/notebooks/* sphinx/source/tutorials
+	@cd sphinx && make html
+
+pages: # Copy sphinx/build/html to docs to create GitHub pages 
+pages:
+	@echo 'Copying documentation to docs'
+	@cp -r sphinx/build/html/* docs 
diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
-# IBM Environmental Intelligence Suite (EIS): Geospatial Analytics open source modules
+# IBM Environmental Intelligence (EI): Geospatial APIs SDK
 
-[![Build Status](https://travis-ci.org/IBM/ibmpairs.svg?branch=master)](https://travis-ci.org/IBM/ibmpairs)
 [![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).
 
-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 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).
 
-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://api.ibm.com/geospatial/run/na/core/v3/](https://pairs.res.ibm.com/manual/api-doc/).
+Sample applications that use `ibmpairs` can be located in the [Environmental-Intelligence](https://github.com/IBM/Environmental-Intelligence/tree/main) project.
 
 
 # General Notes
@@ -25,7 +25,7 @@ simply run
 ```Bash
 pip install --user ibmpairs
 ```
-Then you can import the IBM EIS: Geospatial Analytics API wrapper modules e.g.:
+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
@@ -34,21 +34,7 @@ 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.
+See the documentation [here](https://pages.github.com/IBM/ibmpairs/) and try our tutorials.
 
 
 # Running in a Docker container

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_images/catalogstoragemodel.png b/docs/_images/catalogstoragemodel.png
diff --git a/docs/_images/pairsapproach.jpg b/docs/_images/pairsapproach.jpg
diff --git a/docs/_images/pairsquerying.jpg b/docs/_images/pairsquerying.jpg
diff --git a/docs/_images/pairsusecases.jpg b/docs/_images/pairsusecases.jpg
diff --git a/docs/_images/tutorials_quickstart_quickstartaoiquery_5_0.png b/docs/_images/tutorials_quickstart_quickstartaoiquery_5_0.png
diff --git a/docs/_images/tutorials_quickstart_quickstartaoiquery_9_0.png b/docs/_images/tutorials_quickstart_quickstartaoiquery_9_0.png
diff --git a/docs/_images/tutorials_quickstart_quickstartrasterquery_4_0.png b/docs/_images/tutorials_quickstart_quickstartrasterquery_4_0.png
diff --git a/docs/_sources/examples.rst.txt b/docs/_sources/examples.rst.txt
@@ -0,0 +1,6 @@
+.. _examples:
+
+Examples
+========
+
+Example applications that use ``ibmpairs`` can be located in the `Environmental-Intelligence <https://github.com/IBM/Environmental-Intelligence/tree/main>`_ project.
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,144 @@
+IBM Environmental Intelligence: Geospatial APIs SDK (ibmpairs)
+===============================================================
+
+Getting started
+---------------
+
+To get started using IBM Environmental Intelligence: Geospatial APIs SDK (ibmpairs), take a look at the tutorials.
+
+What's new
+----------
+
+June 14, 2024
+*************
+
+- **3.1.3** Fix in AOI.get in :mod:`query`.
+
+May 24, 2024
+************
+
+- **3.1.2** Added QueryJob.message in :mod:`query`. Fix (unit -> units) in DataLayer.display in :mod:`catalog`.
+
+March 28, 2024
+**************
+
+- **3.1.1** Added constants.CLIENT_TOKEN_REFRESH_MESSAGE_APIC to improve accuracy of authenticaion retry attempt in the Client object in :mod:`client`. Fix in Query.point_data_as_dataframe in :mod:`query`.
+
+March 11, 2024
+**************
+
+- **3.1.0** Added v4 support in :mod:`query`, :mod:`authentication` and :mod:`client`.
+
+January 24, 2024
+****************
+
+- **3.0.9** Fix in Query.async_download in :mod:`query`.
+
+January 22, 2024
+****************
+
+- **3.0.8** Added support for online queries that are automatically converted to batch in :mod:`query`.
+
+January 5, 2024
+***************
+
+- **3.0.7** Fixes for add_dashboard_layer in :mod:`dashboard`.
+
+December 15, 2023
+*****************
+
+- **3.0.6** Added additional csv format support. Fixes for Client init in :mod:`client`.
+
+December 6, 2023
+****************
+
+- **3.0.5** Pinned version of Pillow. Optional verify fix for DataLayers.create in :mod:`catalog`.
+
+November 8, 2023
+****************
+
+- **3.0.4** Fixes for AOIs.search and Query.download in :mod:`query`.
+
+September 22, 2023
+******************
+
+- **3.0.3** Fixes to :mod:`dashboard`.
+
+September 8, 2023
+*****************
+
+- **3.0.2** Added eis_get_auth_token() authentication into :mod:`authentication`.
+
+September 5, 2023
+*****************
+
+- **3.0.1** Added catalog.search into :mod:`catalog`
+
+August 15, 2023
+***************
+
+- **3.0.0** Added capability for /v3/ endpoints.
+
+June 26, 2023
+*************
+
+- **0.2.10** Added new authentication options for /v3/ endpoints.
+
+June 13, 2023
+*************
+
+- **0.2.8** Added an environment selector, added IBM API Connect authentication into :mod:`authentication`.
+
+March 15, 2023
+**************
+
+- **0.2.7** Added a new default timeout in :mod:`client`.
+
+January 18, 2023
+****************
+
+- **0.2.6** A fix to a data type in :mod:`paw`.
+
+November 8, 2022
+****************
+
+- **0.2.5** A fix to allow existing script loggers in :mod:`config`.
+
+September 12, 2022
+******************
+
+- **0.2.4** Added api_key as an alternative for authentication to :mod:`external.ibm` IBMCOSClient.
+
+May 18, 2022
+************
+
+- **0.2.3** A maintenance fix to token refresh in the :mod:`authentication` OAuth2 class.
+
+December 9, 2021
+****************
+
+- **0.2.2** Added :mod:`query` functionality- 'alias' attribute to query.QueryResponseData and 'expression' attribute to query.Filter. Please see Reference for more details.
+
+December 1, 2021
+****************
+
+- **0.2.1** The SDK removed some mandatory requirements to improve the experience of setup on Windows.
+
+December 1, 2021
+*****************
+
+- **0.2.0** The SDK now includes new :mod:`catalog`, :mod:`client`, :mod:`dashboard`, :mod:`query` and :mod:`upload` modules as well as updates to :mod:`authentication`. Please see Reference for more details.
+
+February 24, 2021
+*****************
+
+- **0.1.3** :mod:`paw` now supports OAuth 2.0 authentication by use of a `Geospatial Analytics API key <https://ibm.github.io/Environmental-Intelligence-Suite/geospatial-api.html#authentication>`_.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   tutorials/index
+   reference/index
+   examples
diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt
@@ -0,0 +1,15 @@
+.. _installation:
+
+Installation
+============
+
+Python
+------
+
+IBM Environmental Intelligence: Geospatial APIs SDK (ibmpairs) is a Python SDK, in order to use it you must already have a Python environment with pip installed.
+
+ibmpairs
+--------
+
+To install:
+``pip install ibmpairs``
diff --git a/docs/_sources/reference/api/ibm_api_hub.rst.txt b/docs/_sources/reference/api/ibm_api_hub.rst.txt
@@ -0,0 +1,7 @@
+.. _ibm_api_hub:
+
+API
+===
+
+For the IBM Environmental Intelligence: Geospatial APIs RESTful reference documentation, please see `IBM API Hub  
+<https://developer.ibm.com/apis/catalog/envintelsuite--ibm-environmental-intelligence/Introduction>`_
diff --git a/docs/_sources/reference/api/index.rst.txt b/docs/_sources/reference/api/index.rst.txt
@@ -0,0 +1,5 @@
+.. toctree::
+   :maxdepth: 1
+
+   ibm_api_hub
+   udf_function_reference
diff --git a/docs/_sources/reference/api/udf_function_reference.rst.txt b/docs/_sources/reference/api/udf_function_reference.rst.txt
@@ -0,0 +1,84 @@
+.. _udf_function_reference:
+
+User Defined Functions (UDF)
+============================
+
+.. function:: X + Y
+
+  Returns the sum of layers X and Y.
+
+.. function:: X - Y
+
+  Returns the difference between layers X and Y.
+
+.. function:: X * Y
+
+  Returns the product of layers X and Y.
+
+.. function:: X / Y
+
+  Returns the quotient of layers X and Y.
+
+.. function:: X ? Y : Z
+
+  This is a pixel-wise if-then-else construction. For each pixel, the value is Y if X is true, otherwise Z.
+
+.. function:: math:abs(X)
+
+  Returns the absolute value of layer X.
+
+.. function:: math:acos(X)
+
+  Calculates the inverse cosine (arc cosine) over layer X. The returned angle is in the range :math:`[0, \pi]`.
+
+.. function math:addExact(X, Y)
+
+.. function:: math:asin(X)
+
+  Inverse sine (arc sine) function. The return value is in the range :math:`[-\pi/2, \pi/2]`.
+
+.. function:: math:atan(X)
+
+  Inverse tangent (arc tan) function. The return value is in the range :math:`[-\pi/2, \pi/2]`.
+
+.. function:: math:atan2(X, Y)
+
+.. function:: math:cbrt(X)
+
+  Returns the cube root of X.
+
+.. function:: math:ceil(X)
+
+  Rounds each pixel up to the nearest larger integer.
+
+.. function:: math:copySign(X, Y)
+
+.. function:: math:cos(X)
+
+  Cosine of X.
+
+.. function:: math:cosh(X)
+
+  Hyperbolic cosine of X.
+
+.. function:: math:decrementExact(X)
+
+.. function:: math:exp(X)
+
+  Exponential function.
+
+.. function:: math:expm1(X)
+
+  Returns :math:`e^X - 1`.
+
+.. function:: math:floorDiv(X, Y)
+
+.. function:: math:floorMod(X, Y)
+
+.. function:: math:getExponent(X)
+
+.. function:: math:hypot(X, Y)
+
+  Calculates :math:`\sqrt{X^2 + Y^2}`.
+
+The complete list is based on `java.lang.Math <https://docs.oracle.com/javase/8/docs/api/java/lang/Math.html>`_.
diff --git a/docs/_sources/reference/index.rst.txt b/docs/_sources/reference/index.rst.txt
@@ -0,0 +1,8 @@
+Reference
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   api/index
+   sdk/index
diff --git a/docs/_sources/reference/sdk/ibmpairs_authentication.rst.txt b/docs/_sources/reference/sdk/ibmpairs_authentication.rst.txt
@@ -0,0 +1,5 @@
+Authentication
+==============
+
+.. automodule:: authentication
+   :members:
diff --git a/docs/_sources/reference/sdk/ibmpairs_catalog.rst.txt b/docs/_sources/reference/sdk/ibmpairs_catalog.rst.txt
@@ -0,0 +1,5 @@
+Catalog
+=======
+
+.. automodule:: catalog
+   :members:
diff --git a/docs/_sources/reference/sdk/ibmpairs_client.rst.txt b/docs/_sources/reference/sdk/ibmpairs_client.rst.txt
@@ -0,0 +1,5 @@
+Client
+======
+
+.. automodule:: client
+   :members:
diff --git a/docs/_sources/reference/sdk/ibmpairs_common.rst.txt b/docs/_sources/reference/sdk/ibmpairs_common.rst.txt
@@ -0,0 +1,5 @@
+Common
+======
+
+.. automodule:: common
+   :members: