Migrate to hydromt v1

[veenstrajelmer]

Issue addressed

Fixes #137

Explanation

Since hydromt v1 is now officially out, I think it is wise to update to that new code. This will avoid dependency issues in the future. The API's are quite different so I have a bit of trouble with converting the code.

What I did:

• Updated to v1 with trial and error and the migration manual
• Requires using many public functions, at least functions starting with _, is this expecded?
• tests fail with several errors, see below
• Updated tests\data\test_data.yaml with https://github.com/Deltares/hydromt/blob/main/scripts/migrate_catalog_to_v1.py, suggestions for hydromt documented in: Issues with migrating data_catalog to v1 hydromt#1078.
• Updated hydromt_delft3dfm\data\parameters_data.yml with https://github.com/Deltares/hydromt/blob/main/scripts/migrate_catalog_to_v1.py

Error status on 23-10-2024:

=========================== short test summary info ===========================
FAILED tests/test_dflowfm.py::test_read_write_config_empty_paths - TypeError: expected str, bytes or os.PathLike object, not ModelRoot
FAILED tests/test_dflowfm.py::test_setup_mesh2d_refine - KeyError: 'get_mesh'
FAILED tests/test_dflowfm.py::test_setup_channels - TypeError: expected str, bytes or os.PathLike object, not ModelRoot
FAILED tests/test_dflowfm.py::test_write_structures - TypeError: expected str, bytes or os.PathLike object, not ModelRoot
FAILED tests/test_hydromt.py::test_model_class[piave] - TypeError: expected str, bytes or os.PathLike object, not ModelRoot
FAILED tests/test_hydromt.py::test_model_class[local] - TypeError: expected str, bytes or os.PathLike object, not ModelRoot
FAILED tests/test_hydromt.py::test_model_build[piave] - ImportError: HTTPFileSystem requires "requests" and "aiohttp" to be installed
FAILED tests/test_hydromt.py::test_model_build[local] - TypeError: Model.build() got an unexpected keyword argument 'opt'
FAILED tests/test_hydromt.py::test_model_build_local_code - ImportError: HTTPFileSystem requires "requests" and "aiohttp" to be installed
FAILED tests/test_hydromt.py::test_model_build_piave_code - ImportError: HTTPFileSystem requires "requests" and "aiohttp" to be installed
FAILED tests/test_workflows_mesh.py::test_hydrolib_network_from_mesh - TypeError: expected str, bytes or os.PathLike object, not ModelRoot
FAILED tests/test_workflows_mesh.py::test_setup_links1d2d_add_links - TypeError: expected str, bytes or os.PathLike object, not ModelRoot
================== 12 failed, 1 passed, 4 warnings in 10.79s ==================

Blocking hydromt issues:

• Tests are failing on main hydromt#1093 (blocking all updates to hydromt)
• Model.logger not available hydromt#1080
• GeomsComponent._region_data crashes on too little arguments hydromt#1079 >> fix geom_component._region_data() hydromt#1091
• Codecov is not being updated hydromt#1077 >> added codecov to tests hydromt#1092 (not really a blocker, but makes debugging difficult)
• Add support for Python 3.12 hydromt#540 >> Python 3.12 support hydromt#1094 (not really a blocker since hydromt_delft3dfm tests already pass on python 3.12)

Feedback for hydromt:

• would be useful to include in the migration manual something about deprecating self._is_read_mode() and self.is_write_mode() and how to replace these. The same for self._read() and the fact that self.root has to be replaced by self.root.path.

Checklist

• Updated tests or added new tests
• Branch is up to date with main
• Tests & pre-commit hooks pass
• Updated documentation if needed
• Updated changelog.rst if needed >> useful to put this in the changelog to make users aware

[sonarcloud]

Quality Gate passed

Issues
7 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud