Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/data sources #1039

Merged
merged 11 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions data/catalogs/test_data_catalog.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def test_data_catalog(args, datacatalog):
logger.info("Checking paths of data catalog sources")
for source_name, source in datacatalog.__iter__():
logger.info(f"Checking paths of {source_name}")
if isinstance(source.driver.metadata_resolver, RasterTindexResolver):
if isinstance(source.uri_resolver, RasterTindexResolver):
if not exists(source.full_uri):
error_count += 1
logger.error(
Expand All @@ -84,7 +84,7 @@ def test_data_catalog(args, datacatalog):
continue

else:
paths = source.driver.metadata_resolver.resolve(
paths = source.driver.uri_resolver.resolve(
source.full_uri, source.driver.filesystem
)
for path in paths:
Expand Down
3 changes: 2 additions & 1 deletion docs/api/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ API reference
:maxdepth: 2

cli
data_adapter
data_catalog
data_source
drivers
gis
io
model
stats
plugin
utils
uri_resolvers
49 changes: 49 additions & 0 deletions docs/api/data_adapter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. currentmodule:: hydromt.data_catalog.adapters

DataAdapter
===========

RasterDataset
-------------

.. autosummary::
:toctree: ../_generated

RasterDatasetAdapter
RasterDatasetAdapter.transform

GeoDataset
----------

.. autosummary::
:toctree: ../_generated

GeoDatasetAdapter
GeoDatasetAdapter.transform

GeoDataFrame
------------

.. autosummary::
:toctree: ../_generated

GeoDataFrameAdapter
GeoDataFrameAdapter.transform

DataFrame
---------

.. autosummary::
:toctree: ../_generated

DataFrameAdapter
DataFrameAdapter.transform

Dataset
-------

.. autosummary::
:toctree: ../_generated

DatasetAdapter
DatasetAdapter.transform
246 changes: 0 additions & 246 deletions docs/api/data_catalog.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
.. currentmodule:: hydromt.data_catalog

====
Data
====

.. _api_data_catalog:

Data catalog
Expand All @@ -20,7 +16,6 @@ General
DataCatalog.sources
DataCatalog.predefined_catalogs
DataCatalog.to_dict
DataCatalog.to_dataframe
DataCatalog.to_yml
DataCatalog.export_data
DataCatalog.get_source_bbox
Expand Down Expand Up @@ -63,244 +58,3 @@ Predefined data catalog
PredefinedCatalog.get_catalog_file

predefined_catalog.create_registry_file


DataSource
==========

General
-------

.. autosummary::
:toctree: ../_generated

sources.DataSource
sources.DataSource.summary

RasterDataset
-------------

.. autosummary::
:toctree: ../_generated

sources.RasterDatasetSource
sources.RasterDatasetSource.read_data
sources.RasterDatasetSource.to_stac_catalog
sources.RasterDatasetSource.get_bbox
sources.RasterDatasetSource.get_time_range
sources.RasterDatasetSource.detect_bbox
sources.RasterDatasetSource.detect_time_range

GeoDataFrame
------------

.. autosummary::
:toctree: ../_generated

sources.GeoDataFrameSource
sources.GeoDataFrameSource.read_data
sources.GeoDataFrameSource.to_stac_catalog
sources.GeoDataFrameSource.get_bbox
sources.GeoDataFrameSource.detect_bbox

DataFrame
---------

.. autosummary::
:toctree: ../_generated

sources.DataFrameSource
sources.DataFrameSource.read_data
sources.DataFrameSource.to_stac_catalog

GeoDataset
------------

.. autosummary::
:toctree: ../_generated

sources.GeoDatasetSource
sources.GeoDatasetSource.read_data
sources.GeoDatasetSource.to_stac_catalog
sources.GeoDatasetSource.get_bbox
sources.GeoDatasetSource.detect_bbox

URIResolver
================

General
-------

.. autosummary::
:toctree: ../_generated

uri_resolvers.URIResolver
uri_resolvers.URIResolver.resolve

ConventionResolver
------------------

.. autosummary::
:toctree: ../_generated

uri_resolvers.ConventionResolver
uri_resolvers.ConventionResolver.resolve

RasterTindexResolver
--------------------
.. autosummary::
:toctree: ../_generated

uri_resolvers.RasterTindexResolver
uri_resolvers.RasterTindexResolver.resolve

Driver
======

General
-------

.. autosummary::
:toctree: ../_generated

drivers.base_driver.BaseDriver

RasterDataset
-------------

.. autosummary::
:toctree: ../_generated

drivers.raster.raster_dataset_driver.RasterDatasetDriver
drivers.raster.raster_dataset_driver.RasterDatasetDriver.read
drivers.raster.raster_dataset_driver.RasterDatasetDriver.write

RasterDatasetXarrayDriver
-------------------------

.. autosummary::
:toctree: ../_generated

drivers.raster.raster_xarray_driver.RasterDatasetXarrayDriver
drivers.raster.raster_xarray_driver.RasterDatasetXarrayDriver.read
drivers.raster.raster_xarray_driver.RasterDatasetXarrayDriver.write

RasterioDriver
--------------

.. autosummary::
:toctree: ../_generated

drivers.raster.rasterio_driver.RasterioDriver
drivers.raster.rasterio_driver.RasterioDriver.read
drivers.raster.rasterio_driver.RasterioDriver.write

GeoDataFrame
------------

.. autosummary::
:toctree: ../_generated

drivers.geodataframe.geodataframe_driver.GeoDataFrameDriver
drivers.geodataframe.geodataframe_driver.GeoDataFrameDriver.read
drivers.geodataframe.geodataframe_driver.GeoDataFrameDriver.write

PyogrioDriver
-------------

.. autosummary::
:toctree: ../_generated

drivers.geodataframe.pyogrio_driver.PyogrioDriver
drivers.geodataframe.pyogrio_driver.PyogrioDriver.read
drivers.geodataframe.pyogrio_driver.PyogrioDriver.write

GeoDataFrameTableDriver
-----------------------

.. autosummary::
:toctree: ../_generated

drivers.geodataframe.table_driver.GeoDataFrameTableDriver
drivers.geodataframe.table_driver.GeoDataFrameTableDriver.read
drivers.geodataframe.table_driver.GeoDataFrameTableDriver.write

DataFrame
---------

.. autosummary::
:toctree: ../_generated

drivers.dataframe.dataframe_driver.DataFrameDriver
drivers.dataframe.dataframe_driver.DataFrameDriver.read
drivers.dataframe.dataframe_driver.DataFrameDriver.write

PandasDriver
------------

.. autosummary::
:toctree: ../_generated

drivers.dataframe.pandas_driver.PandasDriver
drivers.dataframe.pandas_driver.PandasDriver.read
drivers.dataframe.pandas_driver.PandasDriver.write

GeoDataFrame
------------

.. autosummary::
:toctree: ../_generated

drivers.geodataset.geodataset_driver.GeoDatasetDriver
drivers.geodataset.geodataset_driver.GeoDatasetDriver.read
drivers.geodataset.geodataset_driver.GeoDatasetDriver.write

DataAdapter
===========

General
-------

RasterDataset
-------------

.. autosummary::
:toctree: ../_generated

adapters.RasterDatasetAdapter
adapters.RasterDatasetAdapter.transform

GeoDataset
----------

.. autosummary::
:toctree: ../_generated

adapters.GeoDatasetAdapter
adapters.GeoDatasetAdapter.transform

GeoDataFrame
------------

.. autosummary::
:toctree: ../_generated

adapters.GeoDataFrameAdapter
adapters.GeoDataFrameAdapter.transform

DataFrame
---------

.. autosummary::
:toctree: ../_generated

adapters.dataframe.DataFrameAdapter
adapters.dataframe.DataFrameAdapter.transform

Dataset
-------

.. autosummary::
:toctree: ../_generated

adapters.DatasetAdapter
Loading
Loading