.. PAIRS documentation master file, created by sphinx-quickstart on Tue Nov 13 14:07:20 2018. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. IBM Environmental Intelligence Suite (EIS): Geospatial Analytics ================================================================ Getting started --------------- To get started using EIS Geospatial Analytics (formerly IBM PAIRS Geoscope), take a look at the api tutorials. What's new ---------- August 15, 2023 *************** - **Python API wrapper** A new release of the python API wrapper (v3.0.0) with capability for /v3/ endpoints. - **/v3/ docs** Initial /v3/ endpoint docs and removal of /v2/ endpoint docs to a legacy folder. June 26, 2023 ************* - **Python API wrapper** Two new releases of the python API wrapper (v0.2.9 & 0.2.10) to add new authentication options for /v3/ endpoints. June 13, 2023 ************* - **Python API wrapper** A new release of the python API wrapper (v0.2.8). Added an environment selector, added IBM API Connect authentication into :mod:`authentication`. March 15, 2023 ************** - **Python API wrapper** A new release of the python API wrapper (v0.2.7). A new default timeout in :mod:`client`. January 18, 2023 **************** - **Python API wrapper** A new release of the python API wrapper (v0.2.6). A fix to a data type in :mod:`paw`. November 8, 2022 **************** - **Python API wrapper** A new release of the python API wrapper (v0.2.5). A fix to allow existing script loggers in :mod:`config`. September 12, 2022 ****************** - **Python API wrapper** A new release of the python API wrapper (v0.2.4). Added api_key as an alternative for authentication to :mod:`external.ibm` IBMCOSClient. May 18, 2022 ************ - **Python API wrapper** A new release of the python API wrapper (v0.2.3). A maintenance fix to token refresh in the :mod:`authentication` OAuth2 class. December 9, 2021 **************** - **Python API wrapper** A new release of the python API wrapper (v0.2.2). Added :mod:`query` functionality- 'alias' attribute to query.QueryResponseData and 'expression' attribute to query.Filter. Please see Reference for more details. December 3, 2021 **************** - **Python API wrapper** A new release of the python API wrapper (v0.2.1). The library removed some mandatory requirements to improve the experience of setup on Windows. November 26, 2021 ***************** - **Python API wrapper** A new release of the python API wrapper (v0.2.0). The library 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 8, 2021 **************** - **JSON Web Token authentication** The Python API wrapper :mod:`paw` now supports OAuth 2.0 authentication by use of a `Geospatial Analytics API key `_. March 23, 2020 ************** - **Python API wrapper** There has been a new release of the python API wrapper. The library now not only includes the :mod:`paw` but also a :mod:`utils` module. The latter includes the class :class:`utils.PAIRSProject` allowing users to submit large numbers of queries by managing queues locally. :mod:`paw` on the other hand now includes functionality to publish query the results of queries submitted via the API back to the PAIRS GUI. See the option ``publish2GUI`` in the constructor of :class:`paw.PAIRSQuery`. - **API documentation** We have considerably expanded the API documentation. February 14, 2020 ***************** - **Batch-mode** A new option in the query syntax that enables users to query a large number of point locations in a single query. Such queries also have full support for user-defined functions. See :ref:`tutorial-batch-mode`. - **CSV output** Similar to :ref:`tutorial-batch-mode`, this new option converts raster data returned by a query from GeoTiff to csv format. February 7, 2020 **************** - **User-defined polygons** The query syntax now allows users to :ref:`specify their own polygons/areas of interest ` rather than relying on AOIs available in PAIRS. In-platform AOIs are still available, of course. - **Spatial aggregation** We have added documentation for this feature. See :ref:`tutorial-api-spatial-aggregation`. - **Python API wrapper** The :mod:`paw` module features a number of new convenience functions regarding logging as well as access credentials. See the sections on logging and environmental variables in :ref:`tutorial-api-paw` for further details. - **Aliases** Admissible values for the ``"alias"`` property of a query are alphanumeric characters as well as underlines. In other words, aliases have to comply with the following regular expression: ``^[0-9a-zA-Z_]+$``. December 4, 2019 **************** - **Post-processors** PAIRS now offers an increasing number of :ref:`tutorial-api-post-processors`. These offer additional, complex data transformations that are applied after a query has completed processing. - **Examples** We have restructured the documentation pages. Most notable are the additions of this **What's new** as well as an :ref:`example ` section. The latter contains :ref:`bias_correction_weather_forecast` as a simple yet powerful use-case of PAIRS. - **PAIRS polygons** We added documentation for one of the less-known features of PAIRS -- the :ref:`polygon API`. It allows users to search IDs of PAIRS polygons/areas of interest and also obtain their precise definitions. .. toctree:: :hidden: :maxdepth: 1 :caption: Contents: tutorials/api/index legacy/index documentation/index .. comment Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`