hydromt.data_catalog.DataCatalog.to_dict#

DataCatalog.to_dict(source_names: List[str] | None = None, root: str | Path | None = None, meta: Dict[str, Any] | None = None, used_only: bool = False) → Dict[str, Any][source]#

Export the data catalog to a dictionary.

Parameters:

  • source_names (list, optional) – List of source names to export, by default None in which case all sources are exported.

  • root (str, Path, optional) – Global root for all relative paths in the file.

  • meta (dict, optional) – key-value pairs to add to the data catalog meta section, such as ‘version’, by default empty.

  • used_only (bool, optional) – If True, export only data entries marked as used, by default False.

Returns:

data catalog dictionary

Return type:

dict