Update documentation for release 1.6.4

Author: lorenz3tla

README.md

@@ -1,7 +1,8 @@
 # QTalsim
 
-QTalsim is a QGIS plugin with four principal functionalities that enable the processing of spatial data suitable for [Talsim](https://www.talsim.de/docs/index.php?title=Hauptseite/en). 
+QTalsim is a QGIS plugin with four principal functionalities that enable the processing of spatial data suitable for [Talsim](https://www.talsim.de/docs/index.php?title=Hauptseite/en).
 
-Firstly, it enables users to calculate Hydrological Response Units (HRUs). Secondly, the plugin faciliates a direct connection to a Talsim database, enabling users to edit system elements, sub-basins and transport reaches. The third functionality allows the user to preprocess sub-basins and calculate the longest flowpaths for each sub-basin. Another functionality downloads data from ISRIC and creates layers containing the soil type and bulk density for a given input area.The fifth functionality allows to map ATKIS land use data to Talsim land uses. 
+Firstly, it enables users to calculate Hydrological Response Units (HRUs). Secondly, the plugin faciliates a direct connection to a Talsim database, enabling users to edit system elements, sub-basins and transport reaches. The third functionality allows the user to preprocess sub-basins and calculate the longest flowpaths for each sub-basin. Another functionality downloads data from ISRIC and creates layers containing the soil type and bulk density for a given input area. The fifth functionality allows to map German land cover data to Talsim land uses.
+
+For detailed information, please refer to the [Full Documentation](https://sydroconsult.github.io/QTalsim/index.html).
 
-For detailed information, please refer to the [Full Documentation](https://sydroconsult.github.io/QTalsim/index.html).

docs/conf.py

@@ -9,7 +9,7 @@
 project = 'QTalsim'
 copyright = '2025, Sydro Consult GmbH'
 author = 'Sydro Consult GmbH'
-release = '1.6.3'
+release = '1.6.4'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/doc_landuse.rst

@@ -2,20 +2,48 @@
 Land use mapping
 ================
 
-   This plugin feature offers the functionality to map land use data to Talsim land use categories. Currently, only the mapping of ATKIS land use data is implemented. 
+   This plugin feature offers the functionality to map land use datasets to Talsim land use categories. This plugin currently supports two German data sources:
 
+* **ATKIS** - Automatisiertes Topographisch-Kartographisches Informationssystem (e.g. `ATKIS NRW <https://www.bezreg-koeln.nrw.de/geobasis-nrw/produkte-und-dienste/landschaftsmodelle/aktuelle-landschaftsmodelle/digitales-basis>`_)
+* **LBM-DE (2021)** - `Digitales Landbedeckungsmodell für Deutschland, Stand 2021 <http://bit.ly/46K4sfd>`_
 
+   The mapping can be found here
 Executing the Plugin
 ^^^^^^^^^^^^^^^^^^^^
-   The user must provide a folder containing all relevant ATKIS layers (e.g., veg01_f, sie01_f, etc.). The plugin automatically detects the necessary files and merges them into a single land use layer. Optionally, the user can specify a clipping layer to limit the extent of the merged result.
 
-   Once merged (and optionally clipped), the plugin maps ATKIS land use types to Talsim-compatible categories using the fields "OBJART_TXT", "FKT", and "VEG".
+ATKIS Data
+----------
+
+   **Input Requirements:**
+   Provide a folder containing all relevant ATKIS layers (e.g., ``veg01_f``, ``sie01_f``, etc.)
+
+   **Processing:**
+   * Plugin automatically detects and merges necessary files into a single land use layer
+   * Optional: Specify a clipping layer to limit the spatial extent
+   * Maps the ATKIS land use types to Talsim-compatible categories using the fields "OBJART_TXT", "FKT", and "VEG". Find the complete `ATKIS to Talsim mapping table here <https://github.com/sydroconsult/QTalsim/blob/main/QTalsim/talsim_parameter/atkis_talsim_zuordnung.csv>`_.
+   
+   |Screenshot Land use mapping ATKIS|
+
+   LBM-DE (2021) Data  
+   ------------------
+   **Input Requirements:**
+   Download data from the link above and add the layer to your current QGIS project
+
+
+   **Processing:**
+   * Specify the layer containing LBM data
+   * Optional: Apply a clipping layer to limit the input extent
+   * Mapping uses fields "LB_AKT" (land cover type) and "SIE_AKT" (imperviousness). Find the complete `LBM to Talsim mapping table here <https://github.com/sydroconsult/QTalsim/blob/main/QTalsim/talsim_parameter/lbm_talsim_zuordnung.csv>`_.
+
+   |Screenshot Land use mapping LBM| 
+
+Output Results
+==============
 
    The output is a GeoPackage containing two land use layers:
 
    - One layer with all land use polygons, where the mapped Talsim land use type is stored in the column "OBJART_NEU".
    - A second, dissolved layer where polygons with the same land use type are aggregated. This layer can be used as input for the HRU Calculation.
 
-   |Screenshot Land use mapping|
-
-.. |Screenshot Land use mapping| image:: qtalsim_screenshots/landuseMappingFeature.png
+.. |Screenshot Land use mapping ATKIS| image:: qtalsim_screenshots/landuseMappingFeature.png
+.. |Screenshot Land use mapping LBM| image:: qtalsim_screenshots/landuseMappingFeatureLBM.png

docs/index.rst

@@ -6,23 +6,23 @@ Welcome to QTalsim's documentation!
 Main Features
 -------------
 
-      -  **HRU Calculation** 
+      -  **HRU Calculation** (:doc:`doc_qtalsim`)
 
          Enables users to calculate Hydrological Response Units (HRUs).
 
-      -  **Sub-basins Preprocessing**  
+      -  **Sub-basins Preprocessing** (:doc:`doc_subbasin_preprocessing`)
 
          Calculates various parameters for each sub-basin and generates files compatible with Talsim.
 
-      -  **ISRIC Soil Type Converter**  
+      -  **ISRIC Soil Type Converter** (:doc:`doc_soil`) 
 
          Downloads and processes data from ISRIC, creating a soil layer that includes soil type and bulk density.
 
-      -  **Land Use Mapping**  
+      -  **Land Use Mapping** (:doc:`doc_landuse`)
 
-         If your area is in Germany, this feature allows you to convert ATKIS land use data into Talsim land use categories.
+         If your area is in Germany, this feature allows you to convert ATKIS land use data or LBM land cover data into Talsim land use categories.
 
-      -  **Connect to Talsim DB**  
+      -  **Connect to Talsim DB** (:doc:`doc_connect_to_db`)
 
          For users of Talsim NG5, this functionality enables a direct connection to a Talsim database, allowing you to edit system elements, sub-basins, and transport reaches.
 
@@ -34,7 +34,7 @@ Contents
 
    install_plugin
    doc_qtalsim
-   doc_connect_to_db
    doc_subbasin_preprocessing
    doc_soil
-   doc_landuse
+   doc_landuse
+   doc_connect_to_db