Hydromt

===================

New
---
- Add support for python 3.12 and 3.13 (540)
- Support all versions of pyarrow (1105)

Changed
-------
- Rasterio have as been limited to ``<1.4.0`` (1097)

Fixed
-----
- Fixed incorrect arguments causing crashes in ``geom_component._region_data()`` (1091)
- Fixed binder integration dockerfile (1098)
- Examples are back in the documentation. (796, 1088)

Deprecated
----------

V1
==

Added
-----
- Added Driver class for customizable io
- Added entrypoints for Driver Plugins as "hydromt.drivers"
- Added entrypoints for ModelComponent Plugins as "hydromt.components"
- Added entrypoints for PredefinedCatalog Plugins as "hydromt.catalogs"
- Added `URIResolver` class for customizable metadata discovery
- Added DataSource class to represent and validate DataCatalog entries.
- Data catalogs can now list multiple roots depending on the system used (linux, windows etc). where the first existing root will be used. (786)
- A Github action now checks whether the migration guide is updated (829)
- Added a `ConfigComponent` to write configurations for kernels/simulations. (863)
- Added a `GeomsComponent` to manage geo-spatial geometry data of a model. (867)
- Added a `DatasetsComponent` to manage multidimensional data of a model. (894)
- Added a `GeoDatasetDriver` to read vector data from tabular formats. (912)
- Added a `GeoDatasetSource` to handle vector data from tabular formats. (912)
- Added `RasterTindexResolver` to handle URIs in raster tindex files. (928)

Changed
-------
- The data catalog format has been refactored to better represent the individual v1 components. (912)
- The `root` meta key of data catalogs yaml files has become `roots` (786)
- The model region is no longer a subset of the `geoms` but rather it's own component class. See the migration guide for more info (810)
- The model class has been moved to a component architecture. See the migration guide for more info (845)
- Changed the `GeoDatasetAdapter` to transform vector data from tabular formats. (912)
- Updated deltares_data data catalog to incorporate the newest data catalog features (667)
- Changed the logging in HydroMT to canonical logging using logging hierarchy (1006)
- Rename variables away from the conventions `fn` and `time_tuple` (1017)
- Implemented reading using `zoom` instead of the ambiguous `zoom_level` (875)

Removed
-------
- support for `**artifact_keys` when initializing the DataCatalog has been removed. (786)
- support for dictionary like features on the DataCatalog have been removed. (790)
- Support for using `.ini` and `.toml` files for configuration has been removed. (791)
- `staticmaps` and `staticgeoms` attributes on the `Model` object have been removed. (845)
- Code refering to the unimplemented Network Model type has been removed (871)
- Removed `_API`, `.api` property, `test_api` and other `Model` level conventions as they are now handled by the components. (894)
- support for using aliases in the DataCatalog has been removed. (987)
- support for `storage_options` in the DataCatalog and adapters has been removed. (987)
- The function `hydromt.gis.flw.guagemap` has been removed in favour of `hydromt.gis.flw.guage_map`. (987)
- The function `hydromt.gis.flw.basinmap` has been removed in favour of `hydromt.gis.flw.basin_map`. (987)
- Support for using the `within` predicate in the function `get_basin_geometry` has been removed. (987)

.. _Semantic Versioning: https://semver.org/spec/v2.0.0.html
.. _Deltares: https://www.deltares.nl/en/

====================

Fixed
-----

- Fix dependencies v0.10 (1112)
- fix resolve path (1114)
- fix attr issue on get_data with variable filter (1117)

====================

New
---
- New `PredefinedCatalog` class to handle predefined catalog version based on pooch registry files. (849)


Changed
-------
- Development environment is now set up via pixi instead of mamba / conda. See the documentation for more information on how to install.
- Use the native data CRS when determining zoom levels over the data catalog crs. (851)
- Improved `flw.d8_from_dem` method with different options to use river vector data to aid the flow direction derivation. (305)
- DataCatalog.predefined_catalogs retrieves predefined_catalogs specified in predefined_catalogs.py. There is no need for setting the predefined_catalogs anymore. (844)


Fixed
-----
- Bug in `raster.transform` with lazy coordinates. (801)
- Bug in `workflows.mesh.mesh2d_from_rasterdataset` with multi-dimensional coordinates. (843)
- Bug in `MeshModel.get_mesh` after xugrid update to 0.9.0. (848)
- Bug in `raster.clip_bbox` when bbox doesn't overlap with raster. (860)
- Allow for string format in zoom_level path, e.g. `{zoom_level:02d}` (851)
- Fixed incorrect renaming of single variable raster datasets (883)
- Provide better error message for 0D geometry arrays in GeoDataset (885)
- Fixed index error when the number of peaks varies between stations in get_hydrographs method (933)

Deprecated
----------
- The `DataCatalog.from_archive` method is deprecated. Use `DataCatalog.from_yml` with the root pointing to the archive instead. (849)

===================
This release fixes a performance regression when reading geometry masks, relaxed warnings for empty raster datasets and updated the documention of the new hydromt commands.

Fixed
-----
- Added back geometry mask when reading vector files with `fiona` as engine/ driver. (777)
- Relaxed empty data checking on `RasterDatasetAdapter`. (782)
- Add documentation for `hydromt check` and `hydromt export` commands. (767)

===================
This release fixes several bugs. Most notably the `NoDataStrategy` is available in much more data reading methods so plugins can use it more directly. Additionally there are some bug fixes relating to reading shapefiles and reading COGs.

Added
-----
- Test script for testing predefined catalogs locally. (735)
- Option to write a data catalog to a csv file (425)

Changed
-------
- Datacatalog preserves variant specific meta data (521)
- Updated DataCatalogValidator to deal with provider and driver_kwargs (521)

Fixed
-----
- Reading Vector formats that consist of more than one file via geopandas. (691)
- Handle NoDataStrategy consistently when reading data in adapters (738)
- add option to ignore empty data sets when exporting data (743)
- Fix bug in `raster._check_dimensions` for datasets with multiple variables with varying dimension size (761)
- Fix bug when reading COGs at requested zoom level (758)