Merge pull request #427 from nens/laterals-csv

Release notes + documentation for releases of May 30 and June 5

source/a_releasenotes_3di_api.rst

@@ -3,6 +3,21 @@
 3Di API
 -------
 
+May 30, 2024
+^^^^^^^^^^^^
+- Implement substance decay (threedi-api #2150)
+
+- Add a *started_from* property to simulations to indicate which user interface started the simulation (3Di Live or 3Di Modeller Interface) (threedi-api #1328)
+
+- Add units to substances (threedi-api #2085, threedigrid #223)
+
+- Add linestring geometry to pumps in geojson (threed-api #1955)
+
+- Bugfix: Assymmetric YZ profiles were not processed correctly (threedigrid #228)
+
+- Bugfix: Simulation with multiple substances no longer crashes (threedi-api #2223)
+
+
 April 29, 2024
 ^^^^^^^^^^^^^^
 

source/a_releasenotes_3di_live.rst

@@ -2,8 +2,32 @@
 
 3Di Live
 --------
+
+June 5th, 2024
+^^^^^^^^^^^^^^
+
+- Improved interpolation of 2D flow visualisation between cells (#1594)
+
+- Improve threedi performance by not redrawing 2D flow 7 times in 1 second (#1686)
+
+- Show exchange level in Breaches details (#1673)
+
+- The UI for the visualisation of 1D and 2D flow has been improved:
+
+	- It has been made clearer which elements are visible/invisible on the map (#1759)
+
+	- For the 1D flow/2D flow settings, the "down arrow" has been replaced with a "settings" icon (#1761)
+
+- File 2D laterals in the simulation template are now also visible on the map in 3Di Live, similar to non-file 2D laterals (#1757)
+
+- Bugfix: "Billing goes to" dropdown was very slow sometimes (#1785)
+
+- Bugfix: opening breaches in 3Di Live did not work for 3Di models generated after May 30th. This has been fixed now (#1843)
+
+
 March 26th, 2024
 ^^^^^^^^^^^^^^^^
+
 - 2D flow is now visualised using traces. The visualisation of 2D flow is based on the flow velocity at the center of the computational grid cells. Note that it does not take into account intra-cell variation of flow velocity or direction. For this reason, you may see flow in dry parts of cells. (#1705, #1703, #1670, #1617, #1682, #1675, #1612, #1576, #1561, #440)
 
 - Hillshade and new colour map in for the DEM (#1671, #1707, #1681, #1677, #1616, #1577)

source/a_releasenotes_3di_mi.rst

@@ -3,6 +3,92 @@
 3Di Modeller Interface
 ----------------------
 
+June 5th, 2024
+^^^^^^^^^^^^^^
+
+3Di Results Analysis 3.8.1
+""""""""""""""""""""""""""
+
+- Time series plotter: allow users to choose substance concentrations as variable (#975)
+
+- Result layers in the Result Aggregation, Cross-Sectional Discharge, and Watershed tools now have the exact same fields and field names as the input node, cell, and flowline layers (#914) 
+
+- Several small issues were fixed in the Watershed tool:
+
+	- Do not empty the result layers when closing the tool (and remove the result sets filter when closing the tool)
+
+	- Do not empty the result layers when toggling "Smooth result watersheds"
+
+	- Only show the relevant target node marker when browsing result sets
+
+	- Do not smooth result watersheds of previous result sets; "smooth result watersheds" now only affects new result sets.
+
+	- Bugfix: Catchment polygon was not created when Browse Results was checked (#655)
+
+- Bugfix: when visualising results on the map, the styling of the flowline results was partly broken in QGIS 3.34 (#1005)
+
+- Bugfix: Processing algorithm "Detect leaking obstacles in DEM" gave a Python error after completion (#1004)
+
+3Di Models & Simulations 3.10.2
+"""""""""""""""""""""""""""""""
+
+- Several new features and improvements have been implemented in the Simulation wizard:
+
+	- The laterals page has been improved (#467) 
+
+	- The CSV file format requirements for :ref:`simulate_api_qgis_boundary_conditions`, :ref:`simulate_api_qgis_laterals`, and :ref:`dry_weather_flow` have been made less strict (#560)
+
+	- You can now add substances to your simulation via laterals (#534, #538). See :ref:`simulation_wizard_substances` for instructions on how to define the substances you want to use in your simulation and :ref:`laterals_substance_concentrations` for instructions on how to add those substances to the lateral discharges in your simulation.
+
+- Bugfix: When sorting, table widgets that include a revision ID treat it as an integer instead of a string (#564)
+
+- When uploading a new revision, simulation templates can now be inherited from the previous revision (#529)
+
+- Compatibility with schema 219 to support 1D vegetation (#532)
+
+
+3Di Schematisation Editor 1.10.1
+""""""""""""""""""""""""""""""""
+
+- **Vegetation** can now also be used in the 1D domain; this has been implemented in the cross-section location attribute form (#188, #229, #235)
+
+- You can now specify a different friction value for each segment of a cross-section with YZ shape (#188, #229, #235).
+
+- Several improvements for **manual editing** have been made:
+
+	- Cross-section location can now be placed on a channel segment, not just on channel vertex (#196)
+
+	- Channel ID is updated when moving a cross-section location (#221)
+
+	- Channel ID is filled in when drawing a potential breach (#230)
+
+	- When moving or changing the geometry of schematisation objects, related objects are also moved (topological editing). The implementation of topological editing has been improved to make it more consistent (#219, #220, #232). The new implementation is:
+		- General topological editing for Connection nodes; when moving a connection node, all schematisation objects that are connected to it are also affected.
+		- Specific logic for Channels:
+			- Cross-section locations are topologically edited when a Channel geometry is edited. Cross-section location can be on a channel vertex or segment.
+			- Potential breaches (start vertex) are topologically edited when Channel geometry is edited. Start vertex of a Potential breach can be on a channel vertex or segment.
+		- Specific logic for Impervious surface:
+			- Impervious surface map is topologically edited when Impervious surface geometry changes. The start vertex of the Impervious surface map is on the *point on surface* of the Impervious surface
+		- Specific logic for Surface:
+			- Surface map is topologically edited when Surface geometry changes. The start vertex of the Surface map is on the *point on surface* of the Surface
+
+- Several improvements have been made to the **vector data importers**:
+
+	- Vector data importers: do not commit changes (#228)
+
+	- Vector data importer: try to convert incompatible geometries to singlepart Point/Polygon/Linestring (#222)
+
+	- Vector data importer: add "expression" as a method (#211)
+
+	- Vector data importer: auto-select source attribute if it matches target attribute#190
+
+	- Import manholes: skip manholes that are snapped to connection nodes that already have a manhole (#224)
+
+- In the processing algorithm "Map (impervious) surfaces to connection nodes", the option has been added to use "Selected features only" for all vector layer inputs (#227)
+
+
+
+
 April 11, 2024
 ^^^^^^^^^^^^^^
 

source/a_releasenotes_computational_core.rst

@@ -3,6 +3,28 @@
 3Di Computational core
 ----------------------
 
+June 5, 2024
+^^^^^^^^^^^^
+
+- Add two step method corrector for water quality calculations to improve stability and reduce numerical diffusion (#794)
+
+- Improved stability of water quality calculations in case of shallow, fast flowing water (#795)
+
+- Bugfix: Load entering via leakage not included in substance summary (#808)
+
+
+May 30, 2024
+^^^^^^^^^^^^
+
+- Timestep handling in the water quality module has been improved significantly (#742, #751, #752). This makes water quality calculations much faster, more stable, and more accurate.
+
+- A decay coefficient (half-life) can now be set for each substance (#700, #775)
+
+- It is now possible to use single vegetation parameter values (constant over the whole cross-section) when using cross-section shape *YZ* and friction type *Chezy with conveyance* (#800)
+
+- Bugfix: Some types of raster NetCDF forcings (e.g. NetCDF rain) were not accepted by the 3Di API because of a bug in the routine that compares the spatial extent of the forcing to the spatial extent of the 3Di model. This has been fixed now (#2221).
+
+
 April 29, 2024
 ^^^^^^^^^^^^^^
 

source/d_1d_objects.rst

@@ -365,7 +365,7 @@ Storage area
 Cross-section location
 ----------------------
 
-Object to define the dimensions, levels, and friction at a specified point along a :ref:`channel`.
+Object to define the dimensions, levels, friction and vegetation properties at a specified point along a :ref:`channel`.
 
 Geometry
 ^^^^^^^^
@@ -436,14 +436,67 @@ Attributes
      - decimal number
      - Yes
      - m\ :sup:`1/2`/s (Chèzy) or s/m\ :sup:`1/3` (Manning)
-     - Friction or roughness value
+     - Friction or roughness value. This global value is superseded in case friction values are provided for each individual segment of a YZ cross-section.
+   * - Friction values
+     - friction_values
+     - text
+     - No
+     - m\ :sup:`1/2`/s (Chèzy) or s/m\ :sup:`1/3` (Manning)
+     - Friction value for each segment of a YZ cross-section. List of decimal numbers, space-separated (in the Spatialite) or comma-separated (in the 3Di Schematisation Editor geopackage). If provided, these values override the single *friction coefficient* value.
    * - Reference level
      - reference_level
      - decimal number
      - Yes
      - m MSL
      - Lowest point of the cross-section
-
+   * - Vegetation height
+     - vegetation_height
+     - Decimal number
+     - Yes
+     - m
+     - Height of the vegetation, i.e. the length of the plant stems. This global value is superseded in case vegetation heights are provided for each individual segment of a YZ cross-section.
+   * - Vegetation heights
+     - vegetation_heights
+     - text
+     - Yes
+     - m
+     - Vegetation heights for each segment of a YZ cross-section. List of decimal numbers, space-separated (in the Spatialite) or comma-separated (in the 3Di Schematisation Editor geopackage). If provided, these values override the single *vegetation height* value.
+   * - Vegetation stem count
+     - vegetation_stem_count
+     - Integer
+     - Yes
+     - #/m\ :sup:`2`
+     - Density of plant stems. List of decimal numbers, space-separated (in the Spatialite) or comma-separated (in the 3Di Schematisation Editor geopackage). This global value is superseded in case vegetation stem counts are provided for each individual segment of a YZ cross-section.
+   * - Vegetation stem counts
+     - vegetation_stem_counts
+     - text
+     - Yes
+     - #/m\ :sup:`2`
+     - Vegetation stem count for each segment of a YZ cross-section. List of decimal numbers, space-separated (in the Spatialite) or comma-separated (in the 3Di Schematisation Editor geopackage). If provided, these values override the single *vegetation stem count* value.
+   * - Vegetation stem diameter
+     - vegetation_stem_diameter
+     - Decimal number
+     - Yes
+     - m
+     - Mean diameter of plant stems. List of decimal numbers, space-separated (in the Spatialite) or comma-separated (in the 3Di Schematisation Editor geopackage). This global value is superseded in case vegetation stem diameters are provided for each individual segment of a YZ cross-section.
+   * - Vegetation stem diameters
+     - vegetation_stem_diameters
+     - text
+     - Yes
+     - m
+     - Vegetation stem diameter for each segment of a YZ cross-section. List of decimal numbers, space-separated (in the Spatialite) or comma-separated (in the 3Di Schematisation Editor geopackage). If provided, these values override the single *vegetation stem diameter* value.
+   * - Vegetation drag coefficient
+     - vegetation_drag_coefficient
+     - Decimal number
+     - Yes
+     - \-
+     - Coefficient to linearly scale the drag that vegetation exerts on the water. The drag resulting from vegetation is different for each situation. A large share of this variation is captured by choosing the correct values for vegetation height, stem count, and stem diameter. The drag coefficient can be used to account for the other factors that affect the drag. The drag coefficient can also be used as a calibration parameter. This global value is superseded in case vegetation drag coefficients are provided for each individual segment of a YZ cross-section.
+   * - Vegetation drag coefficients
+     - vegetation_drag_coefficients
+     - text
+     - Yes
+     - \-
+     - Vegetation drag coefficient for each segment of a YZ cross-section. List of decimal numbers, space-separated (in the Spatialite) or comma-separated (in the 3Di Schematisation Editor geopackage). If provided, these values override the single *vegetation drag coefficient* value.
 
 .. _cross_section_location_notes_for_modellers:
 
@@ -453,6 +506,10 @@ Notes for modellers
 - A cross-section location should be placed on top of a channel vertex that is not the start or end vertex
 - If the channel calculation point distance is smaller than the distance between cross section locations, values in the cross section locations along the channel are interpolated, see :ref:`techref_calculation_point_distance`.
 - If there are multiple cross-section locations between two **calculation nodes** (not connection nodes), only the first cross-section location is used.
+- For YZ cross-sections, friction coefficients and vegetation parameters can be defined for each individual segment of the cross-section. A segment is defined as the domain between two YZ coordinates; so if the YZ cross-section is defined by 10 YZ coordinates, the cross-section will have 9 segments. This option is only available when using friction types *Manning with conveyance* or *Chézy with conveyance*. 
+- When separate values are defined for each segment, the single value will be ignored.
+- For vegetation, either all parameter values must be defined as a single value, or all parameter values must be defined for each segment.
+
 
 Reference level
 """""""""""""""

source/f_3di_instruments_and_downloads.rst

@@ -13,7 +13,7 @@ Install and update manual
 Installing the 3Di Modeller Interface
 ---------------------------------------
 
-To install the 3Di Modeller Interface, download the and execute the `3Di Modeller Interface Installer <https://docs.3di.live/modeller-interface-downloads/3DiModellerInterface-OSGeo4W-3.34.4-1-2-Setup-x86_64.exe>`_
+To install the 3Di Modeller Interface, download the and execute the `3Di Modeller Interface Installer <https://docs.3di.live/modeller-interface-downloads/3DiModellerInterface-OSGeo4W-3.34.5-1-1-Setup-x86_64.exe>`_
 
 
 .. _setting_up_models_and_simulations:

source/h_laterals.rst

@@ -1,9 +1,15 @@
 .. _laterals:
 
-Laterals
-========
+Laterals and dry weather flow
+=============================
 
-Laterals refer in 3Di to point sources and sinks. They can occur in the 1D and in the 2D surface domain. They are treated as any source and sink term, but laterals have a specific location and can vary in time. When one, for example, uses the *tap*-icon in 3Di Live, one adds a lateral.  When adding lateral to the 1D and/or the 2D domain, the time series can be added to the related tables in the spatialite database.
+Laterals are point sources and sinks. Each time step, the volume as specified in the supplied time series is added to the volume of the node or cell they are added to. Laterals can be applied in the 1D and in the 2D surface domain. They are treated as any source and sink term, but laterals have a specific location and can vary in time. 
+
+A specific type of laterals is dry weather flow (DWF). DWF is a 1D lateral with one discharge value each of hour of the day. They are used to simulate the wastewater produced by households or industry, which usually follows a pattern that varies troughout the day.
+
+1D laterals, 2D laterals, and dry weather flow can be defined in the schematisation, so that they will be part of the simulation template that is created along with the 3Di model for that schematisation; see :ref:`2d_lateral`, :ref:`1d_lateral`, and, for :ref:`inflow_objects`.
+
+It is also possible to add laterals and DWF to a simulation if they are not already included in the simulation template; to do this from the 3Di Modeller Interface, see :ref:`simulate_api_qgis_laterals` and :ref:`dry_weather_flow`. 
 
 .. note::
    Negative laterals extract water from the model. If less water is available in the node or cell then what is to be extracted, 3Di will limit the extraction. Just before the cell becomes dry, the extraction discharge will be less than the extraction in the lateral time series. This is done to guarantee stability and capture reality better.