add requirements note for providers (#1040) (#1041)

This commit is contained in:
Tom Kralidis
2022-11-23 08:03:44 -05:00
committed by GitHub
parent fdf19c5f29
commit af72c79267
4 changed files with 26 additions and 4 deletions
@@ -30,6 +30,9 @@ Connection examples
rasterio
^^^^^^^^
.. note::
Requires Python package rasterio
The `rasterio`_ provider plugin reads and extracts any data that rasterio is
capable of handling.
@@ -52,6 +55,9 @@ capable of handling.
xarray
^^^^^^
.. note::
Requires Python package xarray
The `xarray`_ provider plugin reads and extracts `NetCDF`_ and `Zarr`_ data.
.. code-block:: yaml
@@ -31,6 +31,9 @@ Connection examples
xarray-edr
^^^^^^^^^^
.. note::
Requires Python package xarray
The `xarray-edr`_ provider plugin reads and extracts `NetCDF`_ and `Zarr`_ data via `xarray`_.
.. code-block:: yaml
@@ -72,6 +72,9 @@ To publish a GeoJSON file, the file must be a valid GeoJSON FeatureCollection.
Elasticsearch
^^^^^^^^^^^^^
.. note::
Requires Python packages elasticsearch and elasticsearch-dsl
.. note::
Elasticsearch 7 or greater is supported.
@@ -124,6 +127,9 @@ specify the URL for the service layer in the ``data`` field.
OGR
^^^
.. note::
Requires Python package gdal
`GDAL/OGR <https://gdal.org>`_ supports a wide range of spatial file formats, such as shapefile, dxf, gpx, kml,
but also services such as WFS. Read the full list and configuration options at https://gdal.org/drivers/vector.
Additional formats and features are available via the `virtual format <https://gdal.org/drivers/vector/vrt.html#vector-vrt>`_,
@@ -195,6 +201,9 @@ The OGR provider requires a recent (3+) version of GDAL to be installed.
MongoDB
^^^^^^^
.. note::
Requires Python package pymongo
.. note::
Mongo 5 or greater is supported.
@@ -214,6 +223,9 @@ MongoDB
PostgreSQL
^^^^^^^^^^
.. note::
Requires Python packages sqlalchemy, geoalchemy2 and psycopg2-binary
Must have PostGIS installed.
.. note::
@@ -243,7 +255,8 @@ This provider has support for the CQL queries as indicated in the Provider table
SQLiteGPKG
^^^^^^^^^^
.. todo:: add overview and requirements
.. note::
Requries Spatialite installation
SQLite file:
@@ -29,6 +29,8 @@ Connection examples
ElasticsearchCatalogue
^^^^^^^^^^^^^^^^^^^^^^
.. note::
Requires Python packages elasticsearch and elasticsearch-dsl
.. note::
Elasticsearch 7 or greater is supported.
@@ -50,10 +52,8 @@ To publish an Elasticsearch index, the following are required in your index:
TinyDBCatalogue
^^^^^^^^^^^^^^^
.. note::
Elasticsearch 7 or greater is supported.
Requires Python package tinydb
To publish a TinyDB index, the following are required in your index: