v1.0.0-alpha1

[savente93]

V1-Alpha

This is the first alpha release of our v1 implementation with a new model and driver architecture. Please be aware that this is still an alpha so bugs and missing features may still be encountered. If you experience either, please submit an issue or open a discussion, we would love your feedback. Below is the changelog but for a more indepth explanation of all the changes and their implications please see the migration guide at docs/dev/migrating-to-v1.rst.

Because this is an alpha this will not be merged to main for quite a while, and will not be tagged as the latest release. Because we want to be able to respond to feedback quickly, a separate release branch for alpha will be maintained, and more alpha releases may be published as required.

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 MetaDataResolver 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. (Data Catalog roots #786)
• A Github action now checks whether the migration guide is updated (Fix warnings #829)
• Added a ConfigComponent to write configurations for kernels/simulations. (Add ConfigComponent #863)
• Added a GeomsComponent to manage geo-spatial geometry data of a model. (Add GeomsComponent #867)
• Added a DatasetsComponent to manage multidimensional data of a model. (Dataset component #894)
• Added a GeoDatasetDriver to read vector data from tabular formats. (Add GeoDatasetDriver GeoDatasetSource and new GeoDatasetAdapter #912)
• Added a GeoDatasetSource to handle vector data from tabular formats. (Add GeoDatasetDriver GeoDatasetSource and new GeoDatasetAdapter #912)
• Added RasterTindexResolver to handle URIs in raster tindex files. (Add URI resolver for raster_tindex files #928)

Changed

• The data catalog format has been refactored to better represent the individual v1 components. (Add GeoDatasetDriver GeoDatasetSource and new GeoDatasetAdapter #912)
• The root meta key of data catalogs yaml files has become roots (Data Catalog 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 (Add model region class #810)
• The model class has been moved to a component architecture. See the migration guide for more info (Refactor model and components #845)
• Changed the GeoDatasetAdapter to transform vector data from tabular formats. (Add GeoDatasetDriver GeoDatasetSource and new GeoDatasetAdapter #912)

Removed

• support for **artifact_keys when initializing the DataCatalog has been removed. (Data Catalog roots #786)
• support for dictionary like features on the DataCatalog have been removed. (remove dict-like features from data catalog #790)
• Support for using .ini and .toml files for configuration has been removed. (Remove support for .ini and .toml format for configurations #791)
• staticmaps and staticgeoms attributes on the Model object have been removed. (Refactor model and components #845)
• Code refering to the unimplemented Network Model type has been removed (Remove Network model #871)
• Removed _API, .api property, test_api and other Model level conventions as they are now handled by the components. (Dataset component #894)

---

This discussion was created from the release v1.0.0-alpha1.