Skip to content

v1.3.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 18 Dec 13:00
· 87 commits to main since this release
v1.3.0
123db70
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

v1.3.0 (2025-11-11)

ModelComponent API now contains functions for ModelComponent.cleanup and ModelComponent.finish_write that are called by the build and update functions. This stabilizes the write functionality and makes sure that netCDF files can be overwritten when the source and destination are the same. (#778)

New

  • Added ExampleModel class and example_model entrypoint for demonstration purposes.
  • Added option for delayed compute in writing netcdf files
  • Added option to specify a 'fill_value' in gis.raster_utils.full, full_from_transform and full_like. (#1321)
  • Set compression in write_nc
  • Allow masking in GridComponent.set. (#1229)
  • Default driver is now inferred from file extension for RasterDataset, GeoDataFrame, and GeoDataset sources. (#1267)
  • _io.readers.open_nc and _io.readers.open_ncs always return an xr.Dataset. This Dataset is the one that needs to be closed before overwriting on disk.
  • All ModelComponent.write calls return an optional DeferredFileClose that can be called after the open xr.Dataset objects are closed.
  • _io.writers.write_nc writes to a temporary file inside of the working folder of the caller, not to a temporary directory. Changed, because hydromt cannot know how much space is required. The caller should handle their workspaces well.
  • hydromt check accepts a --format flag to check either v1 or v0 data catalogs (#1265)
  • hydromt check accepts a --upgrade flag to upgrade v0 datacatalogs to the new v1 format (#1265)
  • Model can now be used as a context manager. This ensures that all open files are closed when exiting the context. (#1272)
  • RasterioDriver now supports writing tif files. (#1332)

Changed

  • hydromt.io and its functions are now public (underscore removed). (#1271)
  • Reading the hydromt workflow yaml is now done with hydromt.io.read_workflow_yaml. (#1271)
  • Important GIS methods are now public in hydromt.gis.gis_utils, hydromt.gis.raster_utils and hydromt.gis.vector_utils. (#1271)
  • HydroMT raster utilities such as full, full_from_transform, full_like and merge have been moved to hydromt.gis.raster_utils. (#1271)
  • DataCatalog.driver.preprocessing and its functions are now public (underscore removed). (#1271)
  • NoDataStrategy is now part of of hydromt.error and thus public (#1277)
  • hydromt.typing and its functions are now public (underscore removed). (#1286)
  • remove io submodule and move readers and writers to the root module (#1308)
  • write_nc function no longer accepts kwargs, instead a dict to_netcdf_kwargs is used to pass arguments to xarray.to_netcdf. The function raises an error when "compute" is one of the arguments.
  • Function signatures of DataCatalog functions get_rasterdataset, get_geodataframe, get_geodataset, get_dataset and get_dataframe now have: source_kwargs (passed to DataSource.__init__) instead of just kwargs, and time_tuple was renamed to time_range. (#1291)
  • DataCatalog argument fallback_lib has been removed. Users now have to specify the name of the data catalog they want to use, even if it is artifact_data (#1069).
  • GeomsComponent.region now returns the geometric union of all polygonal features in the component instead of a bounding box. Only geometries with area (Polygons and MultiPolygons) contribute to the union; Points, LineStrings, and MultiLineStrings are excluded and assumed to lie within the polygon-defined area. (#1334)
  • When writing zarr files, by default write with zarr_format=2. Can be overwritten with the write_kwargs argument.

Fixed

  • Actually having 'nan' values in a lazy DataArray from gis.raster_utils.full. (#1321)
  • CLI update command was not working. (#1244)
  • Allow models to not have a spatial component (allows updating if region is None). (#1244)
  • CF compliant dimensions in netcdf files
  • buffer argument in DataCatalog.get_rasterdataset now is an integer expressed in resolution multiplicity instead of in meters. (#1245)
  • Improved logging information for build and update functions. (#1237)
  • Better documentation of drivers and their options. (#1271)
  • Passing options to geodataframe_table driver now works. (#1271)
  • Relative path in the workflow yaml were not correctly resolved. (#1304)
  • Fix pydantic for V1 catalog for nodata and fix the catalog upgrade to convert nodata and extra metadata arguments. (#1304)
  • Fix pydantic for V1 catalog for attrs and fix the catalog upgrade to convert attrs arguments.
  • Do not pass metadata "extent" from catalog in xarray objects to avoid issues when writting to netcdf. (#1304)
  • Build and update functions call ModelComponent.cleanup and ModelComponent.finish_write. Stabilizing the write functionality and making sure that netCDF files can be overwritten when the source and destination are the same. (#778)
  • hydromt check has been updated to validate v1 data catalogs (#1265)
  • All handling of log files is now done with the context manager hydromt._utils.log.to_file. This means that they are always closed by the the function that opened them. (#1272)
  • DataCatalog.export_data now correctly handles rasterdata that have been written with paths containing wildcards. (#1323)
  • Standardized the behaviour of DataSources and subcomponents when it comes to handling the case where there is no data.
  • Logging of warnings when unused kwargs are passed.

Deprecated

Removed

  • opt and components CLI options for build and update. A configuration workflow file is now mandatory. (#1244)
  • From the GridComponent, the functions create_from_region, add_data_from_constant, add_data_from_rasterdataset, add_data_from_raster_reclass, add_data_from_geodataframe. (#1229) Equivalent workflows are still available.
  • From the MeshComponent, the functions create_2d_from_region, add_2d_data_from_rasterdataset, add_2d_data_from_raster_reclass. (#1229) Equivalent workflows are still available.
  • GridComponent, MeshComponent, GeomsComponent, and VectorComponent no longer write the region on write. The function SpatialModelComponent.write_region is still available for plugin implementors.
  • stats.eva_block_maxima and stats.eva_peaks_over_threshold. Use stats.eva instead.
Assets 2
Loading