Skip to content

Commit

Permalink
small doc update #235 (#238)
Browse files Browse the repository at this point in the history
  • Loading branch information
hboisgon authored Feb 13, 2024
1 parent 47cfe4b commit a45206c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
13 changes: 7 additions & 6 deletions docs/user_guide/sediment_build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.yml -d data_sources.yml -vvv
hydromt build wflow_sediment path/to/built_model -r "{'basin': [x, y]}" -i wflow_sediment_build.yml -d data_sources.yml -vvv
The recommended `region options <https://deltares.github.io/hydromt/latest/user_guide/model_region>`_
for a proper implementation of the Wflow Sediment model are:
Expand Down Expand Up @@ -43,13 +43,14 @@ Data sources in HydroMT are provided in one of several yaml libraries. These lib
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
- For testing and examples purposes, HydroMT can use the data stored in the
`hydromt-artifacts <https://github.com/DirkEilander/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**
which contains an extract of global data for a small region around the Piave river in Northern Italy. to
use this predefined catalog, the user can add **-d artifact_data** to the build / update command line.
- 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 **-d deltares_data** predefined catalog
to the build / update command line.
- Finally, the user can prepare its own yaml libary (or libraries) (see
- Finally, the user can prepare its own yaml catalog (see
`HydroMT documentation <https://deltares.github.io/hydromt/latest/index>`_ 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.
Expand Down
13 changes: 7 additions & 6 deletions docs/user_guide/wflow_build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ data libraries are set, you can build a model by using:
.. Note::
From HydroMT version 0.7.0 onwards the region argument is optional and should be preceded by a -r or --region flag.
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 .yml configuration file.

The recommended `region options <https://deltares.github.io/hydromt/latest/user_guide/model_region>`_
Expand Down Expand Up @@ -52,13 +52,14 @@ Data sources in HydroMT are provided in one of several yaml libraries. These lib
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
- For testing and examples purposes, HydroMT can use the data stored in the
`hydromt-artifacts <https://github.com/DirkEilander/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**
which contains an extract of global data for a small region around the Piave river in Northern Italy. to
use this predefined catalog, the user can add **-d artifact_data** to the build / update command line.
- 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 **-d deltares_data** predefined catalog
to the build / update command line.
- Finally, the user can prepare its own yaml libary (or libraries) (see
- Finally, the user can prepare its own yaml catalog (see
`HydroMT documentation <https://deltares.github.io/hydromt/latest/index>`_ 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.
Expand Down

0 comments on commit a45206c

Please sign in to comment.