Config ini files should be translated to yml

Deltares / hydromt_wflow

Wflow plugin for HydroMT

https://deltares.github.io/hydromt_wflow/

GNU General Public License v3.0

18 stars 15 forks source link

Config ini files should be translated to yml #207

Closed savente93 closed 9 months ago

savente93 commented 1 year ago

HydroMT-Wflow version checks

[X] I have checked that this issue has not already been reported.
[X] I have checked that this bug exists on the latest version of HydroMT-Wflow.

Reproducible Example

Current behaviour

The wflow config models are currently still in ini format which is deprecated in hydromt-core and will be removed in the 1.0 release.

Desired behaviour

To maintain good support the current config files should be translated to a supported file format such as toml or yaml.

Additional context

No response

DirkEilander commented 9 months ago

This is important for users to be able to select the version of a dataset, which should become common practice for reproducibility! I recommend updating this asap.

setup_soilmaps:
  soil_fn:
    name: soilgrids
    version: 2017

instead of

[setup_soilmaps]
soil_fn=soilgrids

DirkEilander commented 9 months ago

To maintain good support the current config files should be translated to a supported file format such as toml or yaml.

In response to @savente93 issue description: Note that toml is not supported for configuration files and the format should be yml.

savente93 commented 9 months ago

Core does support toml configuration, but I don't really care which is used, so if you care that it's specifically yaml that's fine by me

DirkEilander commented 9 months ago

Apologies @savente93, you are right!! However, I'd be in favour of having a single format supported by HydroMT to keep things simple for ourselves and users. And either-way, this won't be the 'old' ini-format.