Skip to content

Commit

Permalink
deploy: dfb5721
Browse files Browse the repository at this point in the history
  • Loading branch information
@lorenz3tla
lorenz3tla committed Oct 18, 2024
1 parent c77b13f commit 437a482
Show file tree
Hide file tree
Showing 11 changed files with 130 additions and 91 deletions.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/hrus_getting_started.doctree
View file
Binary file not shown.
Binary file modified .doctrees/hrus_step_by_step.doctree
View file
Binary file not shown.
Binary file modified _images/LanduseMapping.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/SelectandEditSoilLayer.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed _images/UploadCSVFile.png
View file
Binary file not shown.
5 changes: 2 additions & 3 deletions _sources/hrus_getting_started.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ Requirements for Input Layers

#. Soil Layer

This layer should contain all soil types within the study area,
but it must only consist of one soil layer. It must contain a
field specifying the names of the soil types.
This layer should contain all soil types within the study area and can consist of up to 6 soil layers. It must contain at least a
field specifying the names of the soil types of one soil layer.

#. Land Use Layer

Expand Down
107 changes: 56 additions & 51 deletions _sources/hrus_step_by_step.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,9 @@ Select & Edit Soil Layer

This table contains Talsim soil parameters in the first column
and all the field names of the soil layer in drop-down menus in
the second column. In this step, users are required to map each
Talsim parameter to its corresponding field in the soil layer.
If the user selects "Feature IDs of Soil Layer" for the ID-column,
it is recommended that the soil input layer is a dissolved layer.
QTalsim takes the feature ids of the input layer.
The table below shows the necessary type for these parameters.
If the user-mapped field has a different datatype, the plugin,
the other six columns. These six columns represent the soil layers. In this step, users are required to map each
Talsim parameter to its corresponding fields in the soil layer.
The table below shows the necessary type for these parameters. Additionally, it also shows the required unit and restrictions of the parameters. If the user-mapped field has a different datatype, the plugin,
where possible, converts the field’s values to the parameter’s
type. If ‘Parameter not available’ is selected, that parameter
will be added with null values.
Expand All @@ -78,22 +74,22 @@ Select & Edit Soil Layer
datatype mismatch between the soil layer’s field and the
parameter, a warning is logged.

=================== ======
Parameter Type
=================== ======
ID_Soil int
NameSoil string
Description string
BulkDensityClass int
Category int
WiltingPoint float
FieldCapacity float
TotalPoreVolume float
KfValue float
MaxInfiltration float
MaxCapillarySuction float
LayerThickness1 float
=================== ======
============================== =========== =========== ===========================
Parameter Unit Type Restriction
============================== =========== =========== ===========================
ID_Soil - int -
NameSoil - string max length 4
Description - string -
BulkDensityClass - int 1 >= x >= 5
Category - int 1 = Sand, 2 = Silt, 3 = Clay
WiltingPoint mm/m float 0 >= x >= 1000
FieldCapacity mm/m float 0 >= x >= 1000
TotalPoreVolume mm/m float 0 >= x >= 1000
KfValue mm/h float 0 > x
MaxInfiltration mm/h float 0 > x
MaxCapillarySuction mm/h float 0 >= x
LayerThickness1 m float 0 > x
============================== =========== =========== ===========================

|Select and Edit Soil Layer|

Expand Down Expand Up @@ -139,44 +135,55 @@ Select and Edit Land use layer
so, all valid geometries of this layer are selected and clipped
to align with the boundaries of the sub-basin layer. During
this process, any duplicate geometries within the layer are
also removed. After confirming the layer, you must then select
the field containing the land use types and confirm this
selection by clicking ‘Confirm Field’. The unique land use
types identified here will be used in a subsequent step.
also removed.

|Select Land use Layer|

- **Upload Talsim Land use Names and Parameters**

The user must upload a CSV-file that includes the Talsim land
use types and their associated parameter values. This can be
done by by clicking ‘Select CSV-File’, which allows the user to
choose the CSV-file. It is important to select the correct
delimiter for the file. After uploading, users can check the
parameters by reviewing the QTalsim-Log.

|CSV-File Land use| |Upload CSV-File|

- **Land use Mapping**
This table contains Talsim soil parameters in the first column
and all the field names of the soil layer in drop-down menus in
the other six columns. These six columns represent the soil layers. In this step, users are required to map each
Talsim parameter to its corresponding fields in the soil layer.
The table below shows the necessary type for these parameters.
If the user-mapped field has a different datatype, the plugin,
where possible, converts the field’s values to the parameter’s
type. If ‘Parameter not available’ is selected, that parameter
will be added with null values.

When you click on ‘Start Landuse Mapping’, the land use mapping
table will be populated with all unique land use types from the
layer in the first column. In the second column, a
dropdown-menu with all Talsim fields of the CSV-file will
appear. Here, you must match each land use type from your data
(in the first column) with the corresponding Talsim land use
type (in the second column). For convenience, the second column
is automatically prefilled with Talsim land use types that have
the same name in the layer and the CSV-file. After completing
the mapping, click ‘Confirm Landuse Mapping’ to create a new
The land use mapping table is populated similarily to the soil mapping table. The first column contains Talsim land use parameters and the second column contains drop-down menus with all field names of the input land use layer.
Here, you must match each Talsim parameter (in the first column) with the corresponding field in the input layer (in the second column).
The table below shows the necessary type for these parameters. Additionally, it also shows the required unit and restrictions of the parameters. If the user-mapped field has a different datatype, the plugin,
where possible, converts the field’s values to the parameter’s
type. If ‘Parameter not available’ is selected, that parameter
will be added with null values.

After completing the mapping, click ‘Confirm Landuse Mapping’ to create a new
layer containing the input fields from your layer and the
Talsim parameter values, as specified in the CSV-file. If the user
defines area/percentage thresholds, land use features below these thresholds are
Talsim parameter values. If the user defines area/percentage thresholds, land use features below these thresholds are
deleted during this step. The user can set a minimum size of
the land use features [m²] and a minimum percentage of the land use features relative to the
corresponding sub-basin's area. Land use features that fall below the specified size or
percentage share are deleted and filled using the ‘Eliminate’-tool.

============================== ====== ===== =====================
Parameter Type Unit Restrictions
============================== ====== ===== =====================
ID_LNZ int - -
Name string - -
RootDepth float m 0 >= x
RootDepthMonthlyPatternId int - -
PlantCoverage float % 0 >= x >= 100
PlantCoverageAnnualPatternId int - -
LeafAreaIndex float - 0 >= x
LeafAreaIndexAnnualPatternId int - -
RoughnessCoefficient float m⅓/s 0 >= x
KcCoeffAnnualPatternId int - -
KyYieldAnnualPatternId int - -
BulkDensityChange int - -
pTAW float - 0 >= x >= 1
============================== ====== ===== =====================

|Land use Mapping|

- **Optional Editing Steps for Land use Layer**
Expand Down Expand Up @@ -330,8 +337,6 @@ Optional Editing Steps
.. |Select and Edit Soil Layer| image:: qtalsim_screenshots/SelectandEditSoilLayer.png
.. |Optional Soil Layer Steps| image:: qtalsim_screenshots/optionalStepsSoilLayer.png
.. |Select Land use Layer| image:: qtalsim_screenshots/SelectLanduseLayer.png
.. |CSV-File Land use| image:: qtalsim_screenshots/CSVFile_Landuse.png
.. |Upload CSV-File| image:: qtalsim_screenshots/UploadCSVFile.png
.. |Land use Mapping| image:: qtalsim_screenshots/LanduseMapping.png
.. |Optional Steps Land Use Layer| image:: qtalsim_screenshots/optionalStepsLanduseLayer.png
.. |Create Land use Layer| image:: qtalsim_screenshots/CreateLanduseLayer.png
Expand Down
5 changes: 2 additions & 3 deletions hrus_getting_started.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,8 @@ <h1>Getting Started with HRUs<a class="headerlink" href="#getting-started-with-h
Unique Identifiers and another one for slope.</p>
</li>
<li><p>Soil Layer</p>
<p>This layer should contain all soil types within the study area,
but it must only consist of one soil layer. It must contain a
field specifying the names of the soil types.</p>
<p>This layer should contain all soil types within the study area and can consist of up to 6 soil layers. It must contain at least a
field specifying the names of the soil types of one soil layer.</p>
</li>
<li><p>Land Use Layer</p>
<p>This layer should contain all land use areas within the study
Expand Down
102 changes: 69 additions & 33 deletions hrus_step_by_step.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,9 @@ <h2>Select &amp; Edit Soil Layer<a class="headerlink" href="#select-edit-soil-la
<li><p><strong>Soil Mapping</strong></p>
<p>This table contains Talsim soil parameters in the first column
and all the field names of the soil layer in drop-down menus in
the second column. In this step, users are required to map each
Talsim parameter to its corresponding field in the soil layer.
If the user selects “Feature IDs of Soil Layer” for the ID-column,
it is recommended that the soil input layer is a dissolved layer.
QTalsim takes the feature ids of the input layer.
The table below shows the necessary type for these parameters.
If the user-mapped field has a different datatype, the plugin,
the other six columns. These six columns represent the soil layers. In this step, users are required to map each
Talsim parameter to its corresponding fields in the soil layer.
The table below shows the necessary type for these parameters. Additionally, it also shows the required unit and restrictions of the parameters. If the user-mapped field has a different datatype, the plugin,
where possible, converts the field’s values to the parameter’s
type. If ‘Parameter not available’ is selected, that parameter
will be added with null values.</p>
Expand All @@ -111,45 +107,92 @@ <h2>Select &amp; Edit Soil Layer<a class="headerlink" href="#select-edit-soil-la
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
<th class="head"><p>Unit</p></th>
<th class="head"><p>Type</p></th>
<th class="head"><p>Restriction</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>ID_Soil</p></td>
<td><ul class="simple">
<li></li>
</ul>
</td>
<td><p>int</p></td>
<td><ul class="simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><p>NameSoil</p></td>
<td><ul class="simple">
<li></li>
</ul>
</td>
<td><p>string</p></td>
<td><p>max length 4</p></td>
</tr>
<tr class="row-even"><td><p>Description</p></td>
<td><ul class="simple">
<li></li>
</ul>
</td>
<td><p>string</p></td>
<td><ul class="simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><p>BulkDensityClass</p></td>
<td><ul class="simple">
<li></li>
</ul>
</td>
<td><p>int</p></td>
<td><p>1 &gt;= x &gt;= 5</p></td>
</tr>
<tr class="row-even"><td><p>Category</p></td>
<td><ul class="simple">
<li></li>
</ul>
</td>
<td><p>int</p></td>
<td><p>1 = Sand, 2 = Silt, 3 = Clay</p></td>
</tr>
<tr class="row-odd"><td><p>WiltingPoint</p></td>
<td><p>mm/m</p></td>
<td><p>float</p></td>
<td><p>0 &gt;= x &gt;= 1000</p></td>
</tr>
<tr class="row-even"><td><p>FieldCapacity</p></td>
<td><p>mm/m</p></td>
<td><p>float</p></td>
<td><p>0 &gt;= x &gt;= 1000</p></td>
</tr>
<tr class="row-odd"><td><p>TotalPoreVolume</p></td>
<td><p>mm/m</p></td>
<td><p>float</p></td>
<td><p>0 &gt;= x &gt;= 1000</p></td>
</tr>
<tr class="row-even"><td><p>KfValue</p></td>
<td><p>mm/h</p></td>
<td><p>float</p></td>
<td><p>0 &gt; x</p></td>
</tr>
<tr class="row-odd"><td><p>MaxInfiltration</p></td>
<td><p>mm/h</p></td>
<td><p>float</p></td>
<td><p>0 &gt; x</p></td>
</tr>
<tr class="row-even"><td><p>MaxCapillarySuction</p></td>
<td><p>mm/h</p></td>
<td><p>float</p></td>
<td><p>0 &gt;= x</p></td>
</tr>
<tr class="row-odd"><td><p>LayerThickness1</p></td>
<td><p>m</p></td>
<td><p>float</p></td>
<td><p>0 &gt; x</p></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -194,35 +237,28 @@ <h2>Select and Edit Land use layer<a class="headerlink" href="#select-and-edit-l
so, all valid geometries of this layer are selected and clipped
to align with the boundaries of the sub-basin layer. During
this process, any duplicate geometries within the layer are
also removed. After confirming the layer, you must then select
the field containing the land use types and confirm this
selection by clicking ‘Confirm Field’. The unique land use
types identified here will be used in a subsequent step.</p>
also removed.</p>
<p><img alt="Select Land use Layer" src="_images/SelectLanduseLayer.png" /></p>
</li>
<li><p><strong>Upload Talsim Land use Names and Parameters</strong></p>
<p>The user must upload a CSV-file that includes the Talsim land
use types and their associated parameter values. This can be
done by by clicking ‘Select CSV-File’, which allows the user to
choose the CSV-file. It is important to select the correct
delimiter for the file. After uploading, users can check the
parameters by reviewing the QTalsim-Log.</p>
<p><img alt="CSV-File Land use" src="_images/CSVFile_Landuse.png" /> <img alt="Upload CSV-File" src="_images/UploadCSVFile.png" /></p>
</li>
<li><p><strong>Land use Mapping</strong></p>
<p>When you click on ‘Start Landuse Mapping’, the land use mapping
table will be populated with all unique land use types from the
layer in the first column. In the second column, a
dropdown-menu with all Talsim fields of the CSV-file will
appear. Here, you must match each land use type from your data
(in the first column) with the corresponding Talsim land use
type (in the second column). For convenience, the second column
is automatically prefilled with Talsim land use types that have
the same name in the layer and the CSV-file. After completing
the mapping, click ‘Confirm Landuse Mapping’ to create a new
<li><p><strong>Land use Mapping</strong>
This table contains Talsim soil parameters in the first column
and all the field names of the soil layer in drop-down menus in
the other six columns. These six columns represent the soil layers. In this step, users are required to map each
Talsim parameter to its corresponding fields in the soil layer.
The table below shows the necessary type for these parameters.
If the user-mapped field has a different datatype, the plugin,
where possible, converts the field’s values to the parameter’s
type. If ‘Parameter not available’ is selected, that parameter
will be added with null values.</p>
<p>The land use mapping table is populated similarily to the soil mapping table. The first column contains Talsim land use parameters and the second column contains drop-down menus with all field names of the input land use layer.
Here, you must match each Talsim parameter (in the first column) with the corresponding field in the input layer (in the second column).
The table below shows the necessary type for these parameters. Additionally, it also shows the required unit and restrictions of the parameters. If the user-mapped field has a different datatype, the plugin,
where possible, converts the field’s values to the parameter’s
type. If ‘Parameter not available’ is selected, that parameter
will be added with null values.</p>
<p>After completing the mapping, click ‘Confirm Landuse Mapping’ to create a new
layer containing the input fields from your layer and the
Talsim parameter values, as specified in the CSV-file. If the user
defines area/percentage thresholds, land use features below these thresholds are
Talsim parameter values. If the user defines area/percentage thresholds, land use features below these thresholds are
deleted during this step. The user can set a minimum size of
the land use features [m²] and a minimum percentage of the land use features relative to the
corresponding sub-basin’s area. Land use features that fall below the specified size or
Expand Down
Loading

0 comments on commit 437a482

Please sign in to comment.