Add changes for 17db805

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a85c151f18087b34b298f51f696c02ce
+config: bd120b75046e284a3069575ad976809d
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/autoapi/geoapis/geometry/index.rst.txt

@@ -1,5 +1,5 @@
-:py:mod:`geoapis.geometry`
-==========================
+geoapis.geometry
+================
 
 .. py:module:: geoapis.geometry
 
@@ -11,29 +11,27 @@
 
 
 
-Module Contents
----------------
-
 Classes
-~~~~~~~
+-------
 
 .. autoapisummary::
 
    geoapis.geometry.TileInfo
 
 
-
+Module Contents
+---------------
 
 .. py:class:: TileInfo(tile_file, catchment_polygon)
 
    A class for working with tiling information
 
-   .. py:property:: file_names
 
+   .. py:property:: file_names
       Return the names of all tiles within the catchment
 
-   .. py:property:: urls
 
+   .. py:property:: urls
       Return the names of all tiles within the catchment
 
 

_sources/autoapi/geoapis/index.rst.txt

@@ -1,5 +1,5 @@
-:py:mod:`geoapis`
-=================
+geoapis
+=======
 
 .. py:module:: geoapis
 
@@ -13,13 +13,13 @@
 
 Submodules
 ----------
+
 .. toctree::
-   :titlesonly:
    :maxdepth: 1
 
-   geometry/index.rst
-   lidar/index.rst
-   raster/index.rst
-   vector/index.rst
+   /autoapi/geoapis/geometry/index
+   /autoapi/geoapis/lidar/index
+   /autoapi/geoapis/raster/index
+   /autoapi/geoapis/vector/index
 
 

_sources/autoapi/geoapis/lidar/index.rst.txt

@@ -1,5 +1,5 @@
-:py:mod:`geoapis.lidar`
-=======================
+geoapis.lidar
+=============
 
 .. py:module:: geoapis.lidar
 
@@ -11,80 +11,87 @@
 
 
 
-Module Contents
----------------
-
 Classes
-~~~~~~~
+-------
 
 .. autoapisummary::
 
    geoapis.lidar.S3QueryBase
    geoapis.lidar.OpenTopography
 
 
-
+Module Contents
+---------------
 
 .. py:class:: S3QueryBase(cache_path, search_polygon = None, redownload_files = False, download_limit_gbytes = 100, verbose = False)
 
    Bases: :py:obj:`abc.ABC`
 
+
    A class to manage fetching LiDAR data from Open Topography.
 
    API details for querying datasets within a search rectangle in a AWS style bucket
 
    All datasets within a search polygon may be downloaded; or datasets may be selected
    by name (either within a search  polygon or the entire dataset).
 
+
    .. py:property:: NETLOC_DATA
       :abstractmethod:
 
       This should be instantiated in the base class. Provide the netloc of the data
       service.
 
+
    .. py:property:: OT_BUCKET
       :abstractmethod:
 
       This should be instantiated in the base class. Provide the netloc of the data
       service.
 
-   .. py:property:: dataset_prefixes
-
-      Get the dataset names of all datasets downloaded by this object.
 
    .. py:method:: run(dataset_name = None)
 
       Download LiDAR dataset(s) either within a search_polygon, by name, or both
 
 
+
    .. py:method:: download_datasets_in_polygon()
 
       Download all LiDAR datasets within the search polygon
 
 
+
    .. py:method:: download_dataset_by_name(dataset_name)
 
       Download a LiDAR dataset by name after checking it is within any specified
       search polygon
 
 
+
    .. py:method:: query_for_datasets_inside_catchment()
 
       Function to check for data in search region using the otCatalogue API
       https://portal.opentopography.org/apidocs/#/Public/getOtCatalog
 
 
+
    .. py:method:: download_dataset(dataset_prefix, client)
 
       Download all files within an optional search polygon of a given
       dataset_prefix
 
 
 
+   .. py:property:: dataset_prefixes
+      Get the dataset names of all datasets downloaded by this object.
+
+
 .. py:class:: OpenTopography(cache_path, search_polygon = None, redownload_files = False, download_limit_gbytes = 100, verbose = False)
 
    Bases: :py:obj:`S3QueryBase`
 
+
    A class to manage fetching LiDAR data from Open Topography
 
    API details for querying datasets within a search rectangle at:

_sources/autoapi/geoapis/raster/index.rst.txt

@@ -1,5 +1,5 @@
-:py:mod:`geoapis.raster`
-========================
+geoapis.raster
+==============
 
 .. py:module:: geoapis.raster
 
@@ -11,11 +11,8 @@
 
 
 
-Module Contents
----------------
-
 Classes
-~~~~~~~
+-------
 
 .. autoapisummary::
 
@@ -26,12 +23,14 @@ Classes
    geoapis.raster.KoordinatesQuery
 
 
-
+Module Contents
+---------------
 
 .. py:class:: KoordinatesExportsQueryBase(key, cache_path, crs = None, bounding_polygon = None)
 
    Bases: :py:obj:`abc.ABC`
 
+
    An abstract class to manage fetching Raster data using the Koordinates exports
    API. Downloads the GeoTiff specified in the run routine.
 
@@ -47,12 +46,14 @@ Classes
    :param bounding_polygon: An option geometry to clip the downloaded GeoTiffs within.
    :type bounding_polygon: geopandas.geodataframe.GeoDataFrame
 
+
    .. py:property:: NETLOC_API
       :abstractmethod:
 
       This should be instantiated in the base class. Provide the netloc of the data
       service.
 
+
    .. py:method:: run(layer)
 
       Query for a specified layer and return a geopandas.GeoDataFrame of the vector
@@ -65,6 +66,7 @@ Classes
 
    Bases: :py:obj:`KoordinatesExportsQueryBase`
 
+
    A class to manage fetching Vector data from LINZ.
 
    LIRS data service can be accessed at: https://https://data.linz.govt.nz/
@@ -76,6 +78,7 @@ Classes
 
    Bases: :py:obj:`KoordinatesExportsQueryBase`
 
+
    A class to manage fetching Vector data from LRIS.
 
    LIRS data service can be accessed at: https://lris.scinfo.org.nz/
@@ -87,6 +90,7 @@ Classes
 
    Bases: :py:obj:`KoordinatesExportsQueryBase`
 
+
    A class to manage fetching Vector data from the Stats NZ datafinder.
 
    Stats NZ data service can be accessed at: datafinder.stats.govt.nz
@@ -98,15 +102,16 @@ Classes
 
    Bases: :py:obj:`KoordinatesExportsQueryBase`
 
+
    A class to manage fetching Vector data from any generic data portal supporting
    WFS.
 
    Note that the 'geometry_name' used when making a WFS 'cql_filter' queries can vary
    between layers. You will need to specify the 'geometry_name' of the layers you want
    to download.
 
-   .. py:property:: NETLOC_API
 
+   .. py:property:: NETLOC_API
       Instantiate the entered netloc of the data service.