hydromt.data_catalog.DataCatalog.to_yml#
- DataCatalog.to_yml(path: str | Path, root: str = 'auto', source_names: List[str] | None = None, used_only: bool = False, meta: Dict[str, Any] | None = None) None [source]#
Write data catalog to yaml format.
- Parameters:
path (
str
,Path
) – yaml output path.root (
str
,Path
, optional) – Global root for all relative paths in yaml file. If “auto” (default) the data source paths are relative to the yaml outputpath
.source_names (
list
, optional) – List of source names to export, by default None in which case all sources are exported. This argument is ignored if used_only=True.used_only (
bool
, optional) – If True, export only data entries kept in used_data list, by default False.meta (
dict
, optional) – key-value pairs to add to the data catalog meta section, such as ‘version’, by default empty.