deploy: 0179d7b

_sources/doc_qtalsim.rst.txt

@@ -4,7 +4,7 @@ HRU calculation
 
    HRU calculation is one core functionality of the QGIS plugin QTalsim,
    designed to create hydrological response units (HRUs) suitable for Talsim. 
-   The plugin processes three layer, including a sub-basin layer, soil layer 
+   The plugin processes three layers, including a sub-basin layer, soil layer 
    and land use layer. It clips the layers in accordance with the sub-basin layer’s boundaries. The plugin then intersects those three layers and creates HRUs.
    Additionally, the plugin offers functionality to remove duplicate geometries, overlapping features and unwanted gaps.
 

_sources/doc_soil.rst.txt

@@ -17,9 +17,7 @@ Executing the Plugin
 
 When the "Download ISRIC Data" button is clicked, the plugin downloads data for clay, silt and sand share, and bulk density within the area defined by the bounding box. The raster files are saved in the specified output folder. The original output files, as returned by ISRIC (in the Homolosine projection), are stored in the 'orig' folder, while the reprojected files (in the user-defined projection) are stored in the 'proj' folder. Each of these folders will contain four files for each of the six soil layers.
 
-   Next, the user can select "Calculate Soil Type." In the first step, the plugin recalculates the values from the mapped units to conventional units, as defined `here <https://www.isric.org/explore/soilgrids/faq-soilgrids#What_do_the_filename_codes_mean>`__. Then, the soil type for each cell is calculated using the clay, silt, and sand proportions, following the soil texture triangle below. The results are saved to the output folder and added to the current QGIS project. In the layer "Soil Types Combined" the soil types of the soil layers are displayed in the different columns of the layer. Additionally, the bulk density values are recalculated and are assigned to the respective bulk density class. This layer is also saved and added to the current Qgis project. 
-
-The layer "Soil Types Combined" produced by this plugin can be used as input to "QTalsim HRU calculation". 
+   Next, the user can select "Calculate Soil Type." In the first step, the plugin recalculates the values from the mapped units to conventional units, as defined `here <https://www.isric.org/explore/soilgrids/faq-soilgrids#What_do_the_filename_codes_mean>`__. Then, the soil type for each cell is calculated using the clay, silt, and sand proportions, following the soil texture triangle below. The results are saved to the output folder and added to the current QGIS project. In the layer "Soil Types Combined" the soil types of the soil layers are displayed in the different columns of the layer. Additionally, the bulk density values are recalculated and are assigned to the respective bulk density class. The soil types and bulk density class values are intersected and merged into one layer. This vector layer holds the BDOD class and soil type name for every cell. This layer "Soil Types BDOD Combined" can be used as soil layer input to "QTalsim HRU calculation". 
 
 .. |Bodenartendreieck| 
 

_sources/hrus_getting_started.rst.txt

@@ -27,27 +27,11 @@ Requirements for Input Layers
       area, and it must contain a field specifying the names of the land
       use types. 
 
-      3.1 CSV-File with Talsim land use types + parameters
 
-         In addition to the land use layer, a CSV-File containing the
-         necessary Talsim land use types and their associated parameters
-         is also required. The screenshot below shows one example of
-         what the first lines of the CSV-file could look like:
+Continue to the next section for detailed step-by-step instructions:
+:ref:`Step-by-Step Guide <hrus-step-by-step>`
 
-         |Screenshot CSV-File|
-
-         The following fields should be included in the CSV-file, the
-         bold fields must be included:
-
-         **ID_LNZ**, **Name**, RootDepth, RootDepthMonthlyPatternId,
-         PlantCoverage, PlantCoverageAnnualPatternId, LeafAreaIndex,
-         LeafAreaIndexAnnualPatternId, RoughnessCoefficient,
-         KcCoeffAnnualPatternId, KyYieldAnnualPatternId,
-         BulkDensityChange, pTAW
-
-         However, the plugin does not require every field to contain
-         values.
+
 
 
-.. |Screenshot CSV-File| image:: qtalsim_screenshots/CSVFile_Landuse.png
 

_sources/hrus_step_by_step.rst.txt

@@ -24,9 +24,8 @@ Elimination of Hydrologic Response Units (HRUs)/small polygons
 .. _elimination_hrus_polygons:
       Specifying values in this section has two different effects.
 
-      Firstly, soil polygons and/or land use areas that fall below the specified size or percentage are eliminated. All features with the same parameters are evaluated. 
-      The percentage is calculated by comparing the size of the polygon to its sub-basin's area. These polygons are eliminated when confirming the soil/land 
-      use mapping, using the chosen elimination mode.
+      This part of the plugin was implemented to eliminate small polygons. Soil polygons and/or land use areas that fall below the specified size or percentage are eliminated. 
+      The percentage of all features with the same parameters is calculated by comparing the size of the polygons to its sub-basin's area. These polygons are eliminated when confirming the soil/land use mapping, using the chosen elimination mode.
 
       Secondly, HRUs are eliminated according to the specified parameters (sub-basin, soil and land use) during the intersection process. HRUs that fall below the specified size or percentage share are deleted and filled using the 'Eliminate' tool. 
       You can select the elimination mode from the drop-down menu (find further information
@@ -75,13 +74,13 @@ Select & Edit Soil Layer
          parameter, a warning is logged.
 
          ==============================     ===========     ===========     ===========================
-         Parameter                           Unit           Type            Restriction
+         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
+         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
@@ -141,9 +140,10 @@ Select and Edit Land use layer
 
 
       -  **Land use Mapping**
+
          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,
+         The table below shows the necessary types 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. 
@@ -156,24 +156,26 @@ Select and Edit Land use layer
          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
+         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
+         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**
@@ -221,7 +223,7 @@ Intersection of Layers
       To generate the HRUs, the three layers (sub-basins, soil and land use) are
       intersected in a first step. The user can set a minimum size of
       the HRUs [m²] and a minimum percentage of HRUs relative to the
-      sub-basin's area (see above). Please note, that the sum of the areas of all HRUs with the same parameters is
+      sub-basin's area (see above). The sum of the areas of all HRUs with the same parameters is
       compared with the area of the corresponding sub-basin. HRUs that fall below the specified size or
       percentage share are deleted and filled using the
       ‘Eliminate’-tool. You can select the elimination-mode from the
@@ -284,6 +286,7 @@ Optional Editing Steps
       of the two polygons.
 
    -  **Delete Overlapping Part of selected Features**
+
       In addition to the option of deleting all overlapping parts
       (using button 'Delete All Overlapping Features'), you can also
       selectively remove specific overlapping soil/land use features. This can

doc_qtalsim.html

@@ -45,7 +45,7 @@ <h1>HRU calculation<a class="headerlink" href="#hru-calculation" title="Permalin
 <blockquote>
 <div><p>HRU calculation is one core functionality of the QGIS plugin QTalsim,
 designed to create hydrological response units (HRUs) suitable for Talsim.
-The plugin processes three layer, including a sub-basin layer, soil layer
+The plugin processes three layers, including a sub-basin layer, soil layer
 and land use layer. It clips the layers in accordance with the sub-basin layer’s boundaries. The plugin then intersects those three layers and creates HRUs.
 Additionally, the plugin offers functionality to remove duplicate geometries, overlapping features and unwanted gaps.</p>
 <p><img alt="Overview QTalsim" src="_images/overviewQTalsim.png" />

doc_soil.html

@@ -54,9 +54,8 @@ <h2>Executing the Plugin<a class="headerlink" href="#executing-the-plugin" title
 </ul>
 <p>When the “Download ISRIC Data” button is clicked, the plugin downloads data for clay, silt and sand share, and bulk density within the area defined by the bounding box. The raster files are saved in the specified output folder. The original output files, as returned by ISRIC (in the Homolosine projection), are stored in the ‘orig’ folder, while the reprojected files (in the user-defined projection) are stored in the ‘proj’ folder. Each of these folders will contain four files for each of the six soil layers.</p>
 <blockquote>
-<div><p>Next, the user can select “Calculate Soil Type.” In the first step, the plugin recalculates the values from the mapped units to conventional units, as defined <a class="reference external" href="https://www.isric.org/explore/soilgrids/faq-soilgrids#What_do_the_filename_codes_mean">here</a>. Then, the soil type for each cell is calculated using the clay, silt, and sand proportions, following the soil texture triangle below. The results are saved to the output folder and added to the current QGIS project. In the layer “Soil Types Combined” the soil types of the soil layers are displayed in the different columns of the layer. Additionally, the bulk density values are recalculated and are assigned to the respective bulk density class. This layer is also saved and added to the current Qgis project.</p>
+<div><p>Next, the user can select “Calculate Soil Type.” In the first step, the plugin recalculates the values from the mapped units to conventional units, as defined <a class="reference external" href="https://www.isric.org/explore/soilgrids/faq-soilgrids#What_do_the_filename_codes_mean">here</a>. Then, the soil type for each cell is calculated using the clay, silt, and sand proportions, following the soil texture triangle below. The results are saved to the output folder and added to the current QGIS project. In the layer “Soil Types Combined” the soil types of the soil layers are displayed in the different columns of the layer. Additionally, the bulk density values are recalculated and are assigned to the respective bulk density class. The soil types and bulk density class values are intersected and merged into one layer. This vector layer holds the BDOD class and soil type name for every cell. This layer “Soil Types BDOD Combined” can be used as soil layer input to “QTalsim HRU calculation”.</p>
 </div></blockquote>
-<p>The layer “Soil Types Combined” produced by this plugin can be used as input to “QTalsim HRU calculation”.</p>
 <figure class="align-default" id="id1">
 <img alt="Bodenartendreieck" src="_images/Bodenartendreieck.png" />
 <figcaption>

hrus_getting_started.html

@@ -61,26 +61,11 @@ <h1>Getting Started with HRUs<a class="headerlink" href="#getting-started-with-h
 <p>This layer should contain all land use areas within the study
 area, and it must contain a field specifying the names of the land
 use types.</p>
-<p>3.1 CSV-File with Talsim land use types + parameters</p>
-<blockquote>
-<div><p>In addition to the land use layer, a CSV-File containing the
-necessary Talsim land use types and their associated parameters
-is also required. The screenshot below shows one example of
-what the first lines of the CSV-file could look like:</p>
-<p><img alt="Screenshot CSV-File" src="_images/CSVFile_Landuse.png" /></p>
-<p>The following fields should be included in the CSV-file, the
-bold fields must be included:</p>
-<p><strong>ID_LNZ</strong>, <strong>Name</strong>, RootDepth, RootDepthMonthlyPatternId,
-PlantCoverage, PlantCoverageAnnualPatternId, LeafAreaIndex,
-LeafAreaIndexAnnualPatternId, RoughnessCoefficient,
-KcCoeffAnnualPatternId, KyYieldAnnualPatternId,
-BulkDensityChange, pTAW</p>
-<p>However, the plugin does not require every field to contain
-values.</p>
-</div></blockquote>
 </li>
 </ol>
 </div></blockquote>
+<p>Continue to the next section for detailed step-by-step instructions:
+<span class="xref std std-ref">Step-by-Step Guide</span></p>
 </section>
 </section>