diff --git a/_archive/README.rst b/_archive/README.rst deleted file mode 100644 index 4668fe83..00000000 --- a/_archive/README.rst +++ /dev/null @@ -1,80 +0,0 @@ -hydroMT-wflow: wflow plugin for hydroMT -####################################### - -.. image:: https://codecov.io/gh/Deltares/hydromt_wflow/branch/main/graph/badge.svg?token=ss3EgmwHhH - :target: https://codecov.io/gh/Deltares/hydromt_wflow - -.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg - :target: https://deltares.github.io/hydromt_wflow/latest - :alt: Latest developers docs - -.. image:: https://img.shields.io/badge/docs-stable-brightgreen.svg - :target: https://deltares.github.io/hydromt_wflow/stable - :alt: Stable docs last release - -.. image:: https://badge.fury.io/py/hydromt_wflow.svg - :target: https://pypi.org/project/hydromt_wflow/ - :alt: Latest PyPI version - -.. image:: https://anaconda.org/conda-forge/hydromt/badges/installer/conda.svg - :target: https://anaconda.org/conda-forge/hydromt_wflow - -.. image:: https://mybinder.org/badge_logo.svg - :target: https://mybinder.org/v2/gh/Deltares/hydromt_wflow/main?urlpath=lab/tree/examples - -hydroMT_ is a python package, developed by Deltares, to build and analysis hydro models. -It provides a generic model api with attributes to access the model schematization, -(dynamic) forcing data, results and states. This plugin provides an implementation -for the wflow_ model. - - -.. _hydromt: https://deltares.github.io/hydromt - -.. _wflow: https://github.com/Deltares/Wflow.jl - - -Installation ------------- - -hydroMT_wflow is available from pypi and conda-forge, but we recommend installing with conda. - -To install hydromt_wflow using conda do: - -.. code-block:: console - - conda install -c conda-forge hydromt_wflow - -This will install both the hydroMT core library and the hydromt_wflow plugin. To get a full installation, -manually add the hydroengine dependency in your environment (not available from conda install): - -.. code-block:: console - - pip install hydroengine - -Documentation -------------- - -Learn more about hydroMT in its `online documentation `_ - -Contributing ------------- - -You can find information about contributing to hydroMT at our `Contributing page `_. - -License -------- - -Copyright (c) 2021, Deltares - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see . diff --git a/_archive/api.rst b/_archive/api.rst deleted file mode 100644 index 629628f6..00000000 --- a/_archive/api.rst +++ /dev/null @@ -1,248 +0,0 @@ -.. currentmodule:: hydromt_wflow - -.. _api_reference: - -############# -API reference -############# - -.. _api_model: - -Wflow model class -================= - -Initialize ----------- - -.. autosummary:: - :toctree: ../generated/ - - WflowModel - -.. _components: - -Setup components ----------------- - -.. autosummary:: - :toctree: ../generated/ - - WflowModel.setup_config - WflowModel.setup_basemaps - WflowModel.setup_rivers - WflowModel.setup_lakes - WflowModel.setup_reservoirs - WflowModel.setup_glaciers - WflowModel.setup_lulcmaps - WflowModel.setup_laimaps - WflowModel.setup_soilmaps - WflowModel.setup_hydrodem - WflowModel.setup_gauges - WflowModel.setup_areamap - WflowModel.setup_precip_forcing - WflowModel.setup_temp_pet_forcing - WflowModel.setup_constant_pars - -Attributes ----------- - -.. autosummary:: - :toctree: ../generated/ - - WflowModel.region - WflowModel.crs - WflowModel.res - WflowModel.root - WflowModel.config - WflowModel.staticmaps - WflowModel.staticgeoms - WflowModel.forcing - WflowModel.states - WflowModel.results - WflowModel.flwdir - WflowModel.basins - WflowModel.rivers - -High level methods ------------------- - -.. autosummary:: - :toctree: ../generated/ - - WflowModel.read - WflowModel.write - WflowModel.build - WflowModel.update - WflowModel.set_root - -General methods ---------------- - -.. autosummary:: - :toctree: ../generated/ - - WflowModel.setup_config - WflowModel.get_config - WflowModel.set_config - WflowModel.read_config - WflowModel.write_config - - WflowModel.set_staticmaps - WflowModel.read_staticmaps - WflowModel.write_staticmaps - WflowModel.clip_staticmaps - - WflowModel.set_staticgeoms - WflowModel.read_staticgeoms - WflowModel.write_staticgeoms - - WflowModel.set_forcing - WflowModel.read_forcing - WflowModel.write_forcing - WflowModel.clip_forcing - - WflowModel.set_states - WflowModel.read_states - WflowModel.write_states - - WflowModel.set_results - WflowModel.read_results - - WflowModel.set_flwdir - -.. _api_model_sediment: - -WflowSediment model class -========================= - -Initialize ----------- - -.. autosummary:: - :toctree: ../generated/ - - WflowSedimentModel - -.. _components_sediment: - -Setup components ----------------- - -.. autosummary:: - :toctree: ../generated/ - - WflowSedimentModel.setup_config - WflowSedimentModel.setup_basemaps - WflowSedimentModel.setup_rivers - WflowSedimentModel.setup_lakes - WflowSedimentModel.setup_reservoirs - WflowSedimentModel.setup_lulcmaps - WflowSedimentModel.setup_laimaps - WflowSedimentModel.setup_canopymaps - WflowSedimentModel.setup_soilmaps - WflowSedimentModel.setup_riverwidth - WflowSedimentModel.setup_riverbedsed - WflowSedimentModel.setup_gauges - WflowSedimentModel.setup_areamap - WflowSedimentModel.setup_constant_pars - -Attributes ----------- - -.. autosummary:: - :toctree: ../generated/ - - WflowSedimentModel.region - WflowSedimentModel.crs - WflowSedimentModel.res - WflowSedimentModel.root - WflowSedimentModel.config - WflowSedimentModel.staticmaps - WflowSedimentModel.staticgeoms - WflowSedimentModel.forcing - WflowSedimentModel.states - WflowSedimentModel.results - WflowSedimentModel.flwdir - WflowSedimentModel.basins - WflowSedimentModel.rivers - -High level methods ------------------- - -.. autosummary:: - :toctree: ../generated/ - - WflowSedimentModel.read - WflowSedimentModel.write - WflowSedimentModel.build - WflowSedimentModel.update - WflowSedimentModel.set_root - -General methods ---------------- - -.. autosummary:: - :toctree: ../generated/ - - WflowSedimentModel.setup_config - WflowSedimentModel.get_config - WflowSedimentModel.set_config - WflowSedimentModel.read_config - WflowSedimentModel.write_config - - WflowSedimentModel.set_staticmaps - WflowSedimentModel.read_staticmaps - WflowSedimentModel.write_staticmaps - WflowSedimentModel.clip_staticmaps - - WflowSedimentModel.set_staticgeoms - WflowSedimentModel.read_staticgeoms - WflowSedimentModel.write_staticgeoms - - WflowSedimentModel.set_forcing - WflowSedimentModel.read_forcing - WflowSedimentModel.write_forcing - WflowSedimentModel.clip_forcing - - WflowSedimentModel.set_states - WflowSedimentModel.read_states - WflowSedimentModel.write_states - - WflowSedimentModel.set_results - WflowSedimentModel.read_results - - WflowSedimentModel.set_flwdir - -.. _workflows: - -Wflow workflows -=============== - -.. autosummary:: - :toctree: ../generated/ - - workflows.hydrography - workflows.topography - workflows.river - workflows.river_bathymetry - workflows.landuse - workflows.soilgrids - workflows.soilgrids_sediment - workflows.waterbodymaps - workflows.reservoirattrs - workflows.glaciermaps - workflows.glacierattrs - - -.. _methods: - -Wflow low-level methods -======================= - -Input/Output methods ---------------------- - -.. autosummary:: - :toctree: ../generated/ - - read_csv_results diff --git a/_archive/sediment.rst b/_archive/sediment.rst deleted file mode 100644 index ddaddb72..00000000 --- a/_archive/sediment.rst +++ /dev/null @@ -1,182 +0,0 @@ -.. currentmodule:: hydromt_wflow.wflow_sediment - -============== -Wflow Sediment -============== -With the hydromt_wflow plugin, you can easily work with wflow sediment models. This plugin helps you preparing or updating -several :ref:`components ` of a wflow sediment model such as topography information, landuse or soil. -The :ref:`main interactions ` are available from the HydroMT Command Line Interface and allow you to configure -HydroMT in order to build or update or clip wflow sediment models. - -When building or updating a model from command line a model region_; a model setup -configuration (.ini file) with model components and options and, optionally, -a data_ sources (.yml) file should be prepared. - -Note that the order in which the components are listed in the ini file is important: - -- `setup_basemaps` should always be run first to determine the model domain -- `setup_rivers` should be run right after `setup_basemaps` as it influences several other setup components (lakes, reservoirs, riverbedsed, floodplains, gauges) - -For python users all WflowSediment attributes and methods are available, see :ref:`api_model_sediment` - -.. _model_components_sed: - -WflowSediment model components -============================== - -An overview of the available WflowSedimentModel setup components -is provided in the table below. When using hydromt from the command line only the -setup components are exposed. Click on -a specific method see its documentation. - -.. autosummary:: - :toctree: ../_generated/ - :nosignatures: - - ~WflowSedimentModel.setup_config - ~WflowSedimentModel.setup_basemaps - ~WflowSedimentModel.setup_rivers - ~WflowSedimentModel.setup_lakes - ~WflowSedimentModel.setup_reservoirs - ~WflowSedimentModel.setup_lulcmaps - ~WflowSedimentModel.setup_laimaps - ~WflowSedimentModel.setup_canopymaps - ~WflowSedimentModel.setup_soilmaps - ~WflowSedimentModel.setup_riverbedsed - ~WflowSedimentModel.setup_gauges - ~WflowModel.setup_areamap - ~WflowSedimentModel.setup_constant_pars - -WflowSediment datamodel -======================= - -The following table provides an overview of which :py:class:`~hydromt_wflow.WflowSedimentModel` -attribute contains which WflowSediment in- and output files. The files are read and written with the associated -read- and write- methods, i.e. :py:func:`~hydromt_wflow.WflowSedimentModel.read_config` -and :py:func:`~hydromt_wflow.WflowSedimentModel.write_config` for the -:py:attr:`~hydromt_wflow.WflowSedimentModel.config` attribute. - - -.. list-table:: WflowSedimentModel data - :widths: 30 70 - :header-rows: 1 - - * - :py:class:`~hydromt_wflow.WflowSedimentModel` attribute - - Wflow sediment files - * - :py:attr:`~hydromt_wflow.WflowSedimentModel.config` - - wflow_sediment.toml - * - :py:attr:`~hydromt_wflow.WflowSedimentModel.staticmaps` - - staticmaps.nc - * - :py:attr:`~hydromt_wflow.WflowSedimentModel.staticgeoms` - - geometries from the staticgeoms folder (basins.geojson, rivers.geojson etc.) - * - :py:attr:`~hydromt_wflow.WflowSedimentModel.forcing` - - inmaps.nc - * - :py:attr:`~hydromt_wflow.WflowSedimentModel.states` - - instates.nc - * - :py:attr:`~hydromt_wflow.WflowSedimentModel.results` - - output.nc, output_scalar.nc, output.csv - -.. _model_config_sed: - -WflowSediment configuration -=========================== - -This HydroMT plugin provides an implementation for the wflow_sediment model in order to build, update or clip from -command line. Specific details on the HydroMT CLI methods can be found in -https://deltares.github.io/hydromt/latest/user_guide/cli.html - -Configuration file ------------------- -Settings to build or update a wflow model are managed in a configuration file. In this file, -every option from each :ref:`model component ` can be changed by the user -in its corresponding section. - -Below is an example of ini file that can be used to build a complete wflow_sediment model -:download:`.ini file <../_examples/wflow_sediment_build.ini>`. Each section corresponds -to a model component with the same name. - -.. literalinclude:: ../_examples/wflow_sediment_build.ini - :language: Ini - -Selecting data --------------- -Data sources in HydroMT are provided in one of several yaml libraries. These libraries contain required -information on the different data sources so that HydroMT can process them for the different models. There -are three ways for the user to select which data libraries to use: - -- If no yaml file is selected, HydroMT will use the data stored in the - `hydromt-artifacts `_ - which contains an extract of global data for a small region around the Piave river in Northern Italy. -- Another options for Deltares users is to select the deltares-data library (requires access to the Deltares - P-drive). In the command lines examples below, this is done by adding either **-dd** or **--deltares-data** - to the build / update command line. -- Finally, the user can prepare its own yaml libary (or libraries) (see - `HydroMT documentation `_ to check the guidelines). - These user libraries can be added either in the command line using the **-d** option and path/to/yaml or in the **ini file** - with the **data_libs** option in the [global] sections. - -Building a model ----------------- -This plugin allows to build a complete model from available data. Once the configuration and -data libraries are set, you can build a model by using: - -.. code-block:: console - - activate hydromt-wflow - hydromt build wflow_sediment path/to/built_model "{'basin': [x, y]}" -i wflow_sediment_build.ini -d data_sources.yml -vvv - -The recommended `region options `_ -for a proper implementation of the wflow_sediment model are: - -- basin -- subbasin - - -Updating a model ----------------- -This plugin allows to update any components from a wflow_sediment model. To do so, list the components to update in a configuration file, -if needed edit your data library with new data sources required for the update and use the command: - -.. code-block:: console - - activate hydromt-wflow - hydromt update wflow_sediment path/to/model_to_update -o path/to/updated_model -i wflow_sediment_update.ini -d data_sources.yml -vvv - - -Clipping a model ----------------- -This plugin allows to clip the following parts of an existing model for a smaller region from command line: - -- staticmaps -- forcing - -To clip a smaller model from an existing one use: - -.. code-block:: console - - activate hydromt-wflow - hydromt clip wflow_sediment path/to/model_to_clip path/to/clipped_model "{'basin' [1001]}" -vvv - -As for building, the recommended `region options `_ -for a proper implementation of the clipped model are: - -- basin -- subbasin - -Extending a wflow model with a wflow_sediment model ---------------------------------------------------- -If you already have a wflow model and you want to extend it in order to include sediment as well, then you do not need to build the -wflow_sediment from scratch. You can instead ``update`` the wflow model with the additional components needed by wflow_sediment. -These components are available in a template :download:`.ini file <../_examples/wflow_extend_sediment.ini>` and shown below. The corresponding -command line would be: - -.. code-block:: console - - activate hydromt-wflow - hydromt update wflow_sediment path/to/wflow_model_to_extend -i wflow_extend_sediment.ini -d data_sources.yml -vvv - -.. literalinclude:: ../_examples/wflow_extend_sediment.ini - :language: Ini - -.. _data: https://deltares.github.io/hydromt/latest/user_guide/data.html -.. _region: https://deltares.github.io/hydromt/latest/user_guide/cli.html#region-options diff --git a/_archive/wflow.rst b/_archive/wflow.rst deleted file mode 100644 index 7ff22dc9..00000000 --- a/_archive/wflow.rst +++ /dev/null @@ -1,168 +0,0 @@ -.. currentmodule:: hydromt_wflow.wflow - -===== -Wflow -===== -With the hydromt_wflow plugin, you can easily work with wflow (SBM) models. This plugin helps you preparing or updating -several :ref:`components ` of a wflow model such as topography information, landuse, soil or forcing. -The :ref:`main interactions ` are available from the HydroMT Command Line Interface and allow you to configure -HydroMT in order to build or update or clip wflow models. - -When building or updating a model from command line a model region_; a model setup -configuration (.ini file) with model components and options and, optionally, -a data_ sources (.yml) file should be prepared. - -Note that the order in which the components are listed in the ini file is important: - -- `setup_basemaps` should always be run first to determine the model domain -- `setup_rivers` should be run right after `setup_basemaps` as it influences several other setup components (lakes, reservoirs, riverwidth, gauges) - -For python users all Wflow attributes and methods are available, see :ref:`api_model` - -.. _model_components: - -Wflow model components -====================== - -An overview of the available WflowModel setup components -is provided in the table below. When using hydromt from the command line only the -setup components are exposed. Click on -a specific method see its documentation. - -.. autosummary:: - :toctree: ../_generated/ - :nosignatures: - - ~WflowModel.setup_config - ~WflowModel.setup_basemaps - ~WflowModel.setup_rivers - ~WflowModel.setup_lakes - ~WflowModel.setup_reservoirs - ~WflowModel.setup_glaciers - ~WflowModel.setup_lulcmaps - ~WflowModel.setup_laimaps - ~WflowModel.setup_soilmaps - ~WflowModel.setup_hydrodem - ~WflowModel.setup_gauges - ~WflowModel.setup_areamap - -Wflow datamodel -=============== - -The following table provides an overview of which :py:class:`~hydromt_wflow.WflowModel` -attribute contains which Wflow in- and output files. The files are read and written with the associated -read- and write- methods, i.e. :py:func:`~hydromt_wflow.wflow.WflowModel.read_config` -and :py:func:`~hydromt_wflow.wflow.WflowModel.write_config` for the -:py:attr:`~hydromt_wflow.wflow.WflowModel.config` attribute. - - -.. list-table:: WflowModel data - :widths: 30 70 - :header-rows: 1 - - * - :py:class:`~hydromt_wflow.WflowModel` attribute - - Wflow files - * - :py:attr:`~hydromt_wflow.WflowModel.config` - - wflow_sbm.toml - * - :py:attr:`~hydromt_wflow.WflowModel.staticmaps` - - staticmaps.nc - * - :py:attr:`~hydromt_wflow.WflowModel.staticgeoms` - - geometries from the staticgeoms folder (basins.geojson, rivers.geojson etc.) - * - :py:attr:`~hydromt_wflow.WflowModel.forcing` - - inmaps.nc - * - :py:attr:`~hydromt_wflow.WflowModel.states` - - instates.nc - * - :py:attr:`~hydromt_wflow.WflowModel.results` - - output.nc, output_scalar.nc, output.csv - -.. _model_config: - -Wflow configuration -=================== -This HydroMT plugin provides an implementation for the wflow model in order to build, update or clip from -command line. Specific details on the HydroMT CLI methods can be found in -https://deltares.github.io/hydromt/latest/user_guide/cli.html - -Configuration file ------------------- -Settings to build or update a wflow model are managed in a configuration file. In this file, -every option from each :ref:`model component ` can be changed by the user -in its corresponding section. - -Below is an example of ini file that can be used to build a complete wflow model -:download:`.ini file <../_examples/wflow_build.ini>`. Each section corresponds -to a model component with the same name. - -.. literalinclude:: ../_examples/wflow_build.ini - :language: Ini - -Selecting data --------------- -Data sources in HydroMT are provided in one of several yaml libraries. These libraries contain required -information on the different data sources so that HydroMT can process them for the different models. There -are three ways for the user to select which data libraries to use: - -- If no yaml file is selected, HydroMT will use the data stored in the - `hydromt-artifacts `_ - which contains an extract of global data for a small region around the Piave river in Northern Italy. -- Another options for Deltares users is to select the deltares-data library (requires access to the Deltares - P-drive). In the command lines examples below, this is done by adding either **-dd** or **--deltares-data** - to the build / update command line. -- Finally, the user can prepare its own yaml libary (or libraries) (see - `HydroMT documentation `_ to check the guidelines). - These user libraries can be added either in the command line using the **-d** option and path/to/yaml or in the **ini file** - with the **data_libs** option in the [global] sections. - -Building a model ----------------- -This plugin allows to build a complete model from available data. Once the configuration and -data libraries are set, you can build a model by using: - -.. code-block:: console - - activate hydromt-wflow - hydromt build wflow path/to/built_model "{'basin': [x, y]}" -i wflow_build.ini -d data_sources.yml -vvv - -The recommended `region options `_ -for a proper implementation of this model are: - -- basin -- subbasin - -Updating a model ----------------- -This plugin allows to update any components from a wflow model. To do so, list the components to update in a configuration file, -if needed edit your data library with new data sources required for the update and use the command: - -.. code-block:: console - - activate hydromt-wflow - hydromt update wflow path/to/model_to_update -o path/to/updated_model -i wflow_update.ini -d data_sources.yml -vvv - - -Clipping a model ----------------- -This plugin allows to clip the following parts of an existing model for a smaller region from command line: - -- staticmaps -- forcing - -To clip a smaller model from an existing one use: - -.. code-block:: console - - activate hydromt-wflow - hydromt clip wflow path/to/model_to_clip path/to/clipped_model "{'basin' [1001]}" -vvv - -As for building, the recommended `region options `_ -for a proper implementation of the clipped model are: - -- basin -- subbasin - ~WflowModel.setup_precip_forcing - ~WflowModel.setup_temp_pet_forcing - ~WflowModel.setup_constant_pars - - -.. _data: https://deltares.github.io/hydromt/latest/user_guide/data.html -.. _region: https://deltares.github.io/hydromt/latest/user_guide/cli.html#region-options diff --git a/docs/changelog.rst b/docs/changelog.rst index 9c6d0ca8..49fc0287 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -21,6 +21,7 @@ Fixed - **setup_reservoirs**: Fix error if optional columns 'Capacity_norm', 'Capacity_min', 'xout', 'yout' are not in reservoir_fn. Allow to pass kwargs to the get_data method. - **setup_lulcmaps**: Fix error when looking for mapping_fn in self.data_catalog - **setup_config_output_timeseries**: bugfix for reducer. +- update hydromt configuration files from ini to yml format. PR #230 - remove or update calls to check if source in self.data_catalog `Issue #501 `_ Deprecated diff --git a/docs/user_guide/sediment_build.rst b/docs/user_guide/sediment_build.rst index 350b164a..1103a6d9 100644 --- a/docs/user_guide/sediment_build.rst +++ b/docs/user_guide/sediment_build.rst @@ -9,7 +9,7 @@ data libraries are set, you can build a model by using: .. code-block:: console activate hydromt-wflow - hydromt build wflow_sediment path/to/built_model "{'basin': [x, y]}" -i wflow_sediment_build.ini -d data_sources.yml -vvv + hydromt build wflow_sediment path/to/built_model "{'basin': [x, y]}" -i wflow_sediment_build.yml -d data_sources.yml -vvv The recommended `region options `_ for a proper implementation of the Wflow Sediment model are: @@ -25,17 +25,17 @@ Settings to build or update a Wflow Sediment model are managed in a configuratio every option from each :ref:`model component ` can be changed by the user in its corresponding section. -Note that the order in which the components are listed in the ini file is important: +Note that the order in which the components are listed in the configuration file is important: - `setup_basemaps` should always be run first to determine the model domain - `setup_rivers` should be run right after `setup_basemaps` as it influences several other setup components (lakes, reservoirs, riverbedsed, floodplains, gauges) -Below is an example ini file that can be used to build a complete Wflow Sediment model -:download:`.ini file <../_examples/wflow_sediment_build.ini>`. Each section corresponds +Below is an example configuration file that can be used to build a complete Wflow Sediment model +:download:`.yml file <../_examples/wflow_sediment_build.yml>`. Each section corresponds to a model component with the same name. -.. literalinclude:: ../_examples/wflow_sediment_build.ini - :language: Ini +.. literalinclude:: ../_examples/wflow_sediment_build.yml + :language: yaml Selecting data -------------- @@ -58,16 +58,16 @@ Extending a Wflow (SBM) model with a Wflow Sediment model --------------------------------------------------------- If you already have a Wflow model and you want to extend it in order to include sediment as well, then you do not need to build the Wflow Sediment model from scratch. You can instead ``update`` the Wflow model with the additional components needed by Wflow Sediment. -These components are available in a template :download:`.ini file <../_examples/wflow_extend_sediment.ini>` and shown below. The corresponding +These components are available in a template :download:`.yml file <../_examples/wflow_extend_sediment.yml>` and shown below. The corresponding command line would be: .. code-block:: console activate hydromt-wflow - hydromt update wflow_sediment path/to/wflow_model_to_extend -o path/to/wflow_sediment_model -i wflow_extend_sediment.ini -d data_sources.yml -vvv + hydromt update wflow_sediment path/to/wflow_model_to_extend -o path/to/wflow_sediment_model -i wflow_extend_sediment.yml -d data_sources.yml -vvv -.. literalinclude:: ../_examples/wflow_extend_sediment.ini - :language: Ini +.. literalinclude:: ../_examples/wflow_extend_sediment.yml + :language: yaml .. _data: https://deltares.github.io/hydromt/latest/user_guide/data.html .. _region: https://deltares.github.io/hydromt/latest/user_guide/cli.html#region-options diff --git a/docs/user_guide/sediment_model_setup.rst b/docs/user_guide/sediment_model_setup.rst index ad34a5bc..4f8ecfb8 100644 --- a/docs/user_guide/sediment_model_setup.rst +++ b/docs/user_guide/sediment_model_setup.rst @@ -8,7 +8,7 @@ HydroMT in order to build or update or clip Wflow Sediment models. When building or updating a model from command line a `model region `_; a model setup -:ref:`configuration ` (.ini file) with model components and options and, optionally, +:ref:`configuration ` (.yml file) with model components and options and, optionally, a `data sources `_ (.yml) file should be prepared. .. currentmodule:: hydromt_wflow diff --git a/docs/user_guide/sediment_update.rst b/docs/user_guide/sediment_update.rst index fa64ac28..d019bff0 100644 --- a/docs/user_guide/sediment_update.rst +++ b/docs/user_guide/sediment_update.rst @@ -14,7 +14,7 @@ To add or change one or more components of an existing Wflow Sediment model the .. code-block:: console activate hydromt-wflow - hydromt update wflow_sediment path/to/model_to_update -o path/to/updated_model -i wflow_sediment_update.ini -d data_sources.yml -vvv + hydromt update wflow_sediment path/to/model_to_update -o path/to/updated_model -i wflow_sediment_update.yml -d data_sources.yml -vvv .. NOTE:: @@ -25,7 +25,7 @@ To add or change one or more components of an existing Wflow Sediment model the By default all model data is written at the end of the update method. If your update however only affects a certain model data (e.g. staticmaps or forcing) you can add a write_* method - (e.g. `write_staticmaps`, `write_forcing`) to the .ini file and only these data will be written. + (e.g. `write_staticmaps`, `write_forcing`) to the .yml file and only these data will be written. Note that the model config is often changed as part of the a model method and `write_config` - should thus be added to the .ini file to keep the model data and config consistent. + should thus be added to the .yml file to keep the model data and config consistent. diff --git a/docs/user_guide/wflow_build.rst b/docs/user_guide/wflow_build.rst index fd3335d5..e38a8614 100644 --- a/docs/user_guide/wflow_build.rst +++ b/docs/user_guide/wflow_build.rst @@ -8,12 +8,12 @@ data libraries are set, you can build a model by using: .. code-block:: console - hydromt build wflow path/to/built_model -r "{'basin': [x, y]}" -i wflow_build.ini -d data_sources.yml -vvv + hydromt build wflow path/to/built_model -r "{'basin': [x, y]}" -i wflow_build.yml -d data_sources.yml -vvv .. Note:: From HydroMT version 0.7.0 onwards the region argument is optional and should be preceded by a -r or --region flag. - The resolution (previously -r) argument has been moved to the setup_basemaps section in the .ini configuration file. + The resolution (previously -r) argument has been moved to the setup_basemaps section in the .yml configuration file. The recommended `region options `_ for a proper implementation of this model are: @@ -34,17 +34,17 @@ Settings to build or update a Wflow model are managed in a configuration file. I every option from each :ref:`model method ` can be changed by the user in its corresponding section. -Note that the order in which the components are listed in the ini file is important: +Note that the order in which the components are listed in the configuration file is important: - `setup_basemaps` should always be run first to determine the model domain - `setup_rivers` should be run right after `setup_basemaps` as it influences several other setup components (lakes, reservoirs, riverwidth, gauges) -Below is an example ini file that can be used to build a complete Wflow model -:download:`.ini file <../_examples/wflow_build.ini>`. Each section corresponds +Below is an example configuration file that can be used to build a complete Wflow model +:download:`.yml file <../_examples/wflow_build.yml>`. Each section corresponds to a model component with the same name. -.. literalinclude:: ../_examples/wflow_build.ini - :language: Ini +.. literalinclude:: ../_examples/wflow_build.yml + :language: yaml Selecting data -------------- diff --git a/docs/user_guide/wflow_model_setup.rst b/docs/user_guide/wflow_model_setup.rst index 7f2d4504..ab727e60 100644 --- a/docs/user_guide/wflow_model_setup.rst +++ b/docs/user_guide/wflow_model_setup.rst @@ -12,7 +12,7 @@ HydroMT in order to build or update or clip Wflow models. When building or updating a model from command line a `model region `_; a model setup -:ref:`configuration ` (.ini file) with model methods and options and, optionally, +:ref:`configuration ` (.yml file) with model methods and options and, optionally, a `data sources `_ (.yml) file should be prepared. .. _model_methods: diff --git a/docs/user_guide/wflow_update.rst b/docs/user_guide/wflow_update.rst index 314bb45d..9e8c91c0 100644 --- a/docs/user_guide/wflow_update.rst +++ b/docs/user_guide/wflow_update.rst @@ -14,7 +14,7 @@ To add or change one or more components of an existing Wflow model the ``update` .. code-block:: console activate hydromt-wflow - hydromt update wflow path/to/model_to_update -o path/to/updated_model -i wflow_update.ini -d data_sources.yml -vvv + hydromt update wflow path/to/model_to_update -o path/to/updated_model -i wflow_update.yml -d data_sources.yml -vvv .. NOTE:: @@ -25,10 +25,10 @@ To add or change one or more components of an existing Wflow model the ``update` By default all model data is written at the end of the update method. If your update however only affects a certain model data (e.g. staticmaps or forcing) you can add a write_* method - (e.g. `write_staticmaps`, `write_forcing`) to the .ini file and only these data will be written. + (e.g. `write_staticmaps`, `write_forcing`) to the .yml file and only these data will be written. Note that the model config is often changed as part of the a model method and `write_config` - should thus be added to the .ini file to keep the model data and config consistent. + should thus be added to the .yml file to keep the model data and config consistent. .. toctree:: :hidden: diff --git a/examples/build_model.ipynb b/examples/build_model.ipynb index 4f89f346..7574e70a 100644 --- a/examples/build_model.ipynb +++ b/examples/build_model.ipynb @@ -87,7 +87,7 @@ "source": [ "# NOTE: copy this line (without !) to your shell for more direct feedback\n", "# NOTE: as of hydromt version 0.7.0 the region argument is optional and should be preceded by -r or --region\n", - "# NOTE: the resolution argument has been removed since hydromt v0.7.0 and can now only be configured from .ini file under the setup_basemap header\n", + "# NOTE: the resolution argument has been removed since hydromt v0.7.0 and can now only be configured from the configuration file under the setup_basemap header\n", "!hydromt build wflow \"./wflow_test_base\" -r \"{'subbasin': [12.2051, 45.8331], 'strord': 4, 'bounds': [11.70, 45.35, 12.95, 46.70]}\" -v -d artifact_data" ] }, @@ -104,7 +104,7 @@ "* `-r \"{'subbasin': [12.2051, 45.8331], 'strord': 4, 'bounds': [11.70, 45.35, 12.95, 46.70]}\"` : derive a subbasin with its outlet at the given x,y coordinates and within the given bounds [xmin, ymin, xmax, ymax] (WGS84) snapped to a river with minimum stream order (strord) of 4. All *REGION* options are described in the [docs](https://deltares.github.io/hydromt/latest/user_guide/model_region)\n", "* `-vv` : give some extra verbosity (2 * v) to display feedback on screen. Now debug messages are provided.\n", "\n", - "NOTE: As we did not specify a model configuration, only the base maps (topography and hydrography) have been setup using default parameters. To build a complete model we need the use a configuraton ini-file." + "NOTE: As we did not specify a model configuration, only the base maps (topography and hydrography) have been setup using default parameters. To build a complete model we need the use a configuraton file." ] }, { @@ -120,9 +120,9 @@ "id": "fb8282c9", "metadata": {}, "source": [ - "The ini-file contains the model setup configuration and determines which methods are used to prepare the different components of a Wflow model and in which order and optionally sets non-default arguments for each method. This configuration is passed to HydroMT using `-i `. We have prepared several example ini-files which are available in the model repository [examples folder](https://github.com/Deltares/hydromt_wflow/tree/main/examples) and from the [docs (building a model)](https://deltares.github.io/hydromt_wflow/latest/user_guide/wflow_build). \n", + "The HydroMT configuration file (YAML) contains the model setup configuration and determines which methods are used to prepare the different components of a Wflow model and in which order and optionally sets non-default arguments for each method. This configuration is passed to HydroMT using `-i `. We have prepared several example files which are available in the model repository [examples folder](https://github.com/Deltares/hydromt_wflow/tree/main/examples) and from the [docs (building a model)](https://deltares.github.io/hydromt_wflow/latest/user_guide/wflow_build). \n", "\n", - "Each header as shown between `[...]` (e.g. `[setup_basemaps]`) corresponds to a model method. All model methods are explained in the [docs (model components)](https://deltares.github.io/hydromt_wflow/latest/user_guide/wflow_model_setup.html). " + "Each header (without indent) (e.g. `setup_basemaps:`) corresponds to a model method. All model methods are explained in the [docs (model components)](https://deltares.github.io/hydromt_wflow/latest/user_guide/wflow_model_setup.html). " ] }, { @@ -130,7 +130,7 @@ "id": "cc3fd44d", "metadata": {}, "source": [ - "We will load the default wflow build ini file for inspection:" + "We will load the default wflow build configuration yaml file for inspection:" ] }, { @@ -140,8 +140,8 @@ "metadata": {}, "outputs": [], "source": [ - "fn_ini = \"wflow_build.ini\"\n", - "with open(fn_ini, \"r\") as f:\n", + "fn_config = \"wflow_build.yml\"\n", + "with open(fn_config, \"r\") as f:\n", " txt = f.read()\n", "print(txt)" ] @@ -186,7 +186,7 @@ "outputs": [], "source": [ "# NOTE: copy this line (without !) to your shell for more direct feedback\n", - "!hydromt build wflow \"./wflow_test_full\" -r \"{'subbasin': [12.2051, 45.8331], 'strord': 4, 'bounds': [11.70, 45.35, 12.95, 46.70]}\" -i wflow_build.ini -d artifact_data -vv" + "!hydromt build wflow \"./wflow_test_full\" -r \"{'subbasin': [12.2051, 45.8331], 'strord': 4, 'bounds': [11.70, 45.35, 12.95, 46.70]}\" -i wflow_build.yml -d artifact_data -vv" ] }, { @@ -195,7 +195,7 @@ "metadata": {}, "source": [ "With this example we build a complete Wflow model including forcing. Compared to the previous **hydromt build** we have added:\n", - "* `-i wflow_build.ini` : setup configuration file including all components to build and their arguments" + "* `-i wflow_build.yml` : setup configuration file including all components to build and their arguments" ] }, { @@ -203,7 +203,7 @@ "id": "2eed76e4", "metadata": {}, "source": [ - "Next we check which files have been created. The model root should contain two netcdf (.nc) files, one for the staticmaps and one for the forcing data, a wflow configuration (.toml) file. These files are sufficient to run the wflow model. In addition several geometry (.geojson) files are saved in the *staticgeoms* folder. Finally, the setup process is logged in the hydromt.log file. " + "Next we check which files have been created. The model root should contain two netcdf (.nc) files, one for the staticmaps and one for the forcing data, a wflow run configuration (.toml) file. These files are sufficient to run the wflow model. In addition several geometry (.geojson) files are saved in the *staticgeoms* folder. Finally, the setup process is logged in the hydromt.log file. " ] }, { @@ -258,7 +258,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.11.4" + "version": "3.11.7" }, "vscode": { "interpreter": { diff --git a/examples/build_sediment.ipynb b/examples/build_sediment.ipynb index c9d85227..fc0e1999 100644 --- a/examples/build_sediment.ipynb +++ b/examples/build_sediment.ipynb @@ -83,9 +83,9 @@ "id": "fb8282c9", "metadata": {}, "source": [ - "The ini-file contains the model setup configuration and determines which methods are used to prepare the different components of a Wflow Sediment model and in which order and optionally sets non-default arguments for each method. This configuration is passed to HydroMT using `-i `. We have prepared several example ini-files which are available in the model repository [examples folder](https://github.com/Deltares/hydromt_wflow/tree/main/examples) and from the [docs (building a model)](https://deltares.github.io/hydromt_wflow/latest/user_guide/sediment_build.html). \n", + "The HydroMT configuration file (YAML) contains the model setup configuration and determines which methods are used to prepare the different components of a Wflow Sediment model and in which order and optionally sets non-default arguments for each method. This configuration is passed to HydroMT using `-i `. We have prepared several example files which are available in the model repository [examples folder](https://github.com/Deltares/hydromt_wflow/tree/main/examples) and from the [docs (building a model)](https://deltares.github.io/hydromt_wflow/latest/user_guide/sediment_build.html). \n", "\n", - "Each header as shown between `[...]` (e.g. `[setup_basemaps]`) corresponds to a model method. All model methods are explained in the [docs (model methods)](https://deltares.github.io/hydromt_wflow/latest/user_guide/sediment_model_setup.html). " + "Each header (without indent) (e.g. `setup_basemaps:`) corresponds to a model method. All model methods are explained in the [docs (model methods)](https://deltares.github.io/hydromt_wflow/latest/user_guide/sediment_model_setup.html). " ] }, { @@ -93,7 +93,7 @@ "id": "cc3fd44d", "metadata": {}, "source": [ - "We will load the default wflow sediment build ini file for inspection:" + "We will load the default wflow sediment build configuration yaml file for inspection:" ] }, { @@ -103,8 +103,8 @@ "metadata": {}, "outputs": [], "source": [ - "fn_ini = \"wflow_sediment_build.ini\"\n", - "with open(fn_ini, \"r\") as f:\n", + "fn_config = \"wflow_sediment_build.yml\"\n", + "with open(fn_config, \"r\") as f:\n", " txt = f.read()\n", "print(txt)" ] @@ -128,8 +128,8 @@ "source": [ "# NOTE: copy this line (without !) to your shell for more direct feedback\n", "# NOTE: as of hydromt version 0.7.0 the region argument is optional and should be preceded by -r or --region\n", - "# NOTE: the resolution argument has been removed since hydromt v0.7.0 and can now only be configured from .ini file under the setup_basemap header\n", - "!hydromt build wflow_sediment \"./wflow_test_sediment\" -r \"{'subbasin': [12.2051, 45.8331], 'strord': 4, 'bounds': [11.70, 45.35, 12.95, 46.70]}\" -i wflow_sediment_build.ini -d artifact_data -vv" + "# NOTE: the resolution argument has been removed since hydromt v0.7.0 and can now only be configured from the configuration file under the setup_basemap header\n", + "!hydromt build wflow_sediment \"./wflow_test_sediment\" -r \"{'subbasin': [12.2051, 45.8331], 'strord': 4, 'bounds': [11.70, 45.35, 12.95, 46.70]}\" -i wflow_sediment_build.yml -d artifact_data -vv" ] }, { @@ -143,7 +143,7 @@ "* `wflow_sediment` : i.e. build a wflow sediment model\n", "* `./wflow_test_sediment` : output model folder\n", "* `-r \"{'subbasin': [12.2051, 45.8331], 'strord': 4, 'bounds': [11.70, 45.35, 12.95, 46.70]}\"` : derive a subbasin with its outlet at the given x,y coordinates and within the given bounds [xmin, ymin, xmax, ymax] (WGS84) snapped to a river with minimum stream order (strord) of 4. All *REGION* options are described in the [docs](https://deltares.github.io/hydromt/latest/user_guide/model_region)\n", - "* `-i wflow_sediment_build.ini` : model setup configuration file\n", + "* `-i wflow_sediment_build.yml` : model setup configuration file\n", "* `-d artifact_data` : use pre-defined artifact_data catalog.\n", "* `-vv` : give some extra verbosity (2 * v) to display feedback on screen. Now debug messages are provided.\n" ] @@ -153,7 +153,7 @@ "id": "2eed76e4", "metadata": {}, "source": [ - "Next we check which files have been created. The model root should contain two netcdf (.nc) files, one for the staticmaps and one for the forcing data, a wflow configuration (.toml) file. These files are sufficient to run the wflow sediment model. In addition several geometry (.geojson) files are saved in the *staticgeoms* folder. Finally, the setup process is logged in the hydromt.log file. " + "Next we check which files have been created. The model root should contain two netcdf (.nc) files, one for the staticmaps and one for the forcing data, a wflow run configuration (.toml) file. These files are sufficient to run the wflow sediment model. In addition several geometry (.geojson) files are saved in the *staticgeoms* folder. Finally, the setup process is logged in the hydromt.log file. " ] }, { @@ -208,7 +208,7 @@ "source": [ "If you already have a hydrological **Wflow** model and you want to extend it in order to include **sediment** as well, then you do not need to build the wflow_sediment from scratch. You can instead **update** the wflow model with the additional components needed by wflow_sediment. \n", "\n", - "These components are available in the template **wflow_extend_sediment.ini**:" + "These components are available in the template **wflow_extend_sediment.yml**:" ] }, { @@ -218,8 +218,8 @@ "metadata": {}, "outputs": [], "source": [ - "fn_ini = \"wflow_extend_sediment.ini\"\n", - "with open(fn_ini, \"r\") as f:\n", + "fn_config = \"wflow_extend_sediment.yml\"\n", + "with open(fn_config, \"r\") as f:\n", " txt = f.read()\n", "print(txt)" ] @@ -240,7 +240,7 @@ "outputs": [], "source": [ "# NOTE: copy this line (without !) to your shell for more direct feedback\n", - "!hydromt update wflow_sediment \"wflow_piave_subbasin\" -o \"./wflow_test_extend_sediment\" -i wflow_extend_sediment.ini -d artifact_data -vv" + "!hydromt update wflow_sediment \"wflow_piave_subbasin\" -o \"./wflow_test_extend_sediment\" -i wflow_extend_sediment.yml -d artifact_data -vv" ] }, { @@ -253,7 +253,7 @@ "* `wflow_sediment` : i.e. update a wflow_sediment model (in our case a wflow model but with wflow_sediment components)\n", "* `wflow_piave_subbasin` : hydrological wflow model folder\n", "* `-o \"./wflow_test_extend_sediment\"`: output combined wflow hydrology+sediment models\n", - "* `-i wflow_extend_sediment.ini` : setup configuration file containing wflow sediment specific components\n", + "* `-i wflow_extend_sediment.yml` : setup configuration file containing wflow sediment specific components\n", "* `-d artifact_data` : use the pre-defined artifact_data catalog\n", "* `-vv` : give some extra verbosity (2 * v) to display feedback on screen. Now debug messages are provided." ] @@ -275,7 +275,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.11.6" + "version": "3.11.7" }, "vscode": { "interpreter": { diff --git a/examples/linux64/wflow_sediment_piave_subbasin/staticmaps.nc b/examples/linux64/wflow_sediment_piave_subbasin/staticmaps.nc index 133f6417..f3b9d3b7 100644 Binary files a/examples/linux64/wflow_sediment_piave_subbasin/staticmaps.nc and b/examples/linux64/wflow_sediment_piave_subbasin/staticmaps.nc differ diff --git a/examples/linux64/wflow_sediment_piave_subbasin/wflow_sediment.toml b/examples/linux64/wflow_sediment_piave_subbasin/wflow_sediment.toml index 5cf67b30..15b4d958 100644 --- a/examples/linux64/wflow_sediment_piave_subbasin/wflow_sediment.toml +++ b/examples/linux64/wflow_sediment_piave_subbasin/wflow_sediment.toml @@ -124,6 +124,7 @@ reslocs = "wflow_reservoirlocs" lakearea = "LakeArea" lakeareas = "wflow_lakeareas" lakelocs = "wflow_lakelocs" +bankfull_depth = "RiverDepth" [output.lateral.river] SSconc = "SSconc" diff --git a/examples/update_model_forcing.ipynb b/examples/update_model_forcing.ipynb index 3fb8fdb9..56185c8b 100644 --- a/examples/update_model_forcing.ipynb +++ b/examples/update_model_forcing.ipynb @@ -62,11 +62,11 @@ "source": [ "Updating landuse is an easy step with the command line but sometimes, for example with forcing, you want to update several things at the same time. This is possible by preparing a **configuration file** that includes every methods and settings that you want to do during your update.\n", "\n", - "The ini-file contains the model setup configuration and determines which methods are updated and in which sequence and sets optional arguments for each method. This configuration is passed to hydromt using `-i `.\n", + "The HydroMT configuration file (YAML) contains the model setup configuration and determines which methods are updated and in which sequence and sets optional arguments for each method. This configuration is passed to hydromt using `-i `.\n", "\n", - "Each header as shown between `[...]` (e.g. `[setup_precip_forcing]`) corresponds with a model method which are explained in the [docs (model methods)](https://deltares.github.io/hydromt_wflow/latest/user_guide/wflow_model_setup.html).\n", + "Each header (without indent) (e.g. `setup_precip_forcing:`) corresponds with a model method which are explained in the [docs (model methods)](https://deltares.github.io/hydromt_wflow/latest/user_guide/wflow_model_setup.html).\n", "\n", - "Let's open the example configuration file **wflow_update_forcing.ini** from the model repository [examples folder] and have a look at the settings." + "Let's open the example configuration file **wflow_update_forcing.yml** from the model repository [examples folder] and have a look at the settings." ] }, { @@ -76,8 +76,8 @@ "metadata": {}, "outputs": [], "source": [ - "fn_ini = \"wflow_update_forcing.ini\"\n", - "with open(fn_ini, \"r\") as f:\n", + "fn_config = \"wflow_update_forcing.yml\"\n", + "with open(fn_config, \"r\") as f:\n", " txt = f.read()\n", "print(txt)" ] @@ -93,6 +93,8 @@ "- **setup_precip_forcing**: tells hydroMT how to prepare precipitation data including from which data source and with or without downscaling.\n", "- **setup_temp_pet_forcing**: tells hydroMT how to prepare temperature and potential evapotranspiration data including which data source, which computation method for PET and with or without downscaling.\n", "\n", + "We also decide to not write our forcing not as one file but one file per month.\n", + "\n", "You can find more information on the different methods and their options in the [docs (model methods)](https://deltares.github.io/hydromt_wflow/latest/user_guide/wflow_model_setup.html).\n", "\n", "Here we can see that we will prepare daily forcing for 10 days in February 2010 using CHIRPS for precipitation and ERA5 for temperature and potential evapotranspiration." @@ -141,7 +143,7 @@ "outputs": [], "source": [ "# NOTE: copy this line (without !) to your shell for more direct feedback\n", - "! hydromt update wflow wflow_piave_subbasin -o ./wflow_piave_forcing -i wflow_update_forcing.ini -d artifact_data -v" + "! hydromt update wflow wflow_piave_subbasin -o ./wflow_piave_forcing -i wflow_update_forcing.yml -d artifact_data -v" ] }, { @@ -154,7 +156,7 @@ "- `update wflow`: i.e. update a wflow model\n", "- `wflow_piave_subbasin`: original model folder\n", "- `-o ./wflow_piave_forcing`: output updated model folder\n", - "- `-i wflow_update_forcing.ini`: setup configuration file containing the components to update and their different options\n", + "- `-i wflow_update_forcing.yml`: setup configuration file containing the components to update and their different options\n", "- `-d artifact_data`: specify to use the artifact_data catalog\n", "- `v`: give some extra verbosity (2 * v) to display feedback on screen. Now debug messages are provided." ] @@ -253,7 +255,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.2" + "version": "3.11.7" } }, "nbformat": 4, diff --git a/examples/wflow_build.ini b/examples/wflow_build.ini deleted file mode 100644 index 44932e66..00000000 --- a/examples/wflow_build.ini +++ /dev/null @@ -1,93 +0,0 @@ -[setup_config] # options parsed to wflow ini file
.