Merge pull request Universite-Gustave-Eiffel#571 from gpetit/add_inpu…

…t_param

Add input param

Docs/Input_acoustics.rst

@@ -0,0 +1,123 @@
+Acoustic parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In the different WPS scripts of NoiseModelling, you will find many input parameters, mandatory or optional. 
+
+Below we list the most important ones, indicating, where necessary, the default values and those we recommend (from an acoustic point of view).
+
+.. figure:: images/Input_tables/acoustics_parameters_banner.png
+ :align: center
+
+
+
+The following parameters may be found in the scripts dealing with noise emission or propagation (*e.g* ``Noise_level_from_traffic``, ``Noise_level_from_source```, ...)
+
+
+Probability of occurrences
+--------------------------------
+
+* Parameter name: ``confFavorableOccurrencesXXXXX`` (with ``XXXXX`` = evening, day, night, ...)
+* Description: Comma-delimited string containing the probability ([0,1]) of occurrences of favourable propagation conditions. Follow the clockwise direction. The north slice is the last array index (n°16 in the schema below) not the first one
+* Type: Double
+* Default value: ``0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5``
+* Recommanded value: 
+
+.. figure:: images/Input_tables/acoustics_parameters_confFavorableOccurrences.png
+ :align: center
+
+Relative humidity
+--------------------------------
+
+* Parameter name: ``confHumidity``
+* Description: Humidity for noise propagation (%) [0,100]
+* Type: Double
+* Default value: ``70``
+* Recommanded value: depends on the average conditions at the location where you perform the simulation
+
+Air temperature
+--------------------------------
+
+* Parameter name: ``confTemperature``
+* Description: Air temperature (°C)
+* Type: Double
+* Default value: ``15``
+* Recommanded value: depends on the average conditions at the location where you perform the simulation
+
+Order of reflexion
+--------------------------------
+
+* Parameter name: ``confReflOrder``
+* Description: Maximum number of reflections to be taken into account. Warning: adding 1 order increases the processing time significantly
+* Type: Integer
+* Default value: ``1``
+* Recommanded value: ``1`` or ``2``
+
+Diffraction on horizontal edges
+--------------------------------
+
+* Parameter name: ``confDiffHorizontal``
+* Description: Compute or not the diffraction on horizontal edges
+* Type: Boolean
+* Default value: ``False``
+* Recommanded value: ``True``
+
+Diffraction on vertical edges
+--------------------------------
+
+* Parameter name: ``confDiffVertical``
+* Description: Compute or not the diffraction on vertical edges. Following Directive 2015/996, enable this option for rail and industrial sources only
+* Type: Boolean
+* Default value: ``False``
+* Recommanded value: 
+
+Maximum source-receiver distance
+----------------------------------
+
+* Parameter name: ``confMaxSrcDist``
+* Description: Maximum distance between source and receiver (meters)
+* Type: Double
+* Default value: ``150``
+* Recommanded value: Between ``500`` and ``800``
+
+.. figure:: images/Input_tables/acoustics_parameters_confMaxSrcDist.png
+ :align: center
+
+Maximum source-reflexion distance
+------------------------------------
+
+* Parameter name: ``confMaxReflDist``
+* Description: Maximum search distance of walls / facades from the "Source-Receiver" segment, for the calculation of specular reflections (meters)
+* Type: Double
+* Default value: ``50``
+* Recommanded value: Between ``350`` and ``800``
+
+.. figure:: images/Input_tables/acoustics_parameters_confMaxReflDist.png
+ :align: center
+
+
+Wall absorption coefficient
+--------------------------------
+
+* Parameter name: ``paramWallAlpha``
+* Description: Wall absorption coefficient [0,1] (between ``0`` : "fully absorbent" and ``1`` : "fully reflective")
+* Type: Double
+* Default value: ``0.1``
+* Recommanded value: ``0.1``
+
+Separate receiver level by source identifier
+---------------------------------------------
+
+* Parameter name: ``confExportSourceId``
+* Description: Keep source identifier in output in order to get noise contribution of each noise source
+* Type: Boolean
+* Default value: ``False``
+* Recommanded value: 
+
+Thread number
+--------------------------------
+
+* Parameter name: ``confThreadNumber``
+* Description: Number of thread to use on the computer
+* Type: Integer
+* Default value: ``0`` (``0`` = Automatic. Will check the number of cores and apply -1. (*e.g*: 8 cores = 7 cores will be used))
+* Recommanded value: ``0``

Docs/Input_buildings.rst

@@ -5,7 +5,7 @@ NoiseModelling is a tool for producing noise maps. To do so, at different stages
 
 Below we describe the table ``BUILDINGS``, dealing with buildings. 
 
-The other tables are accessible via the left menu in the ``Input tables`` section.
+The other tables are accessible via the left menu in the ``Input tables & parameters`` section.
 
 .. figure:: images/Input_tables/building_banner.png
  :align: center

Docs/Input_dem.rst

@@ -5,7 +5,7 @@ NoiseModelling is a tool for producing noise maps. To do so, at different stages
 
 Below we describe the table ``DEM``, dealing with the Digital Elevation Model matrix. 
 
-The other tables are accessible via the left menu in the ``Input tables`` section.
+The other tables are accessible via the left menu in the ``Input tables & parameters`` section.
 
 
 .. figure:: images/Input_tables/dem_banner.png
@@ -31,6 +31,9 @@ DEM enrichment
 
 If you have input data with a good elevation quality (better than the DEM one) / higher density and if you are comfortable with GIS tools, you are invited to enrich your DEM so that it takes into account the structuring elements of the territory.
 
+.. note::
+ You can find dedicated scripts (*e.g* ``Enrich_DEM_with_lines``, ...) in the ``Geometric Tools`` section of the left-side menu of NoiseModelling
+
 Below is an example of DEM enrichment using road network:
 
 #. Roads (red lines) are inserted into the DEM (blue points),

Docs/Input_ground.rst

@@ -5,7 +5,7 @@ NoiseModelling is a tool for producing noise maps. To do so, at different stages
 
 Below we describe the table ``GROUND``, dealing with the land use type, with an associated ground absorption coefficient (G). 
 
-The other tables are accessible via the left menu in the ``Input tables`` section.
+The other tables are accessible via the left menu in the ``Input tables & parameters`` section.
 
 .. figure:: images/Input_tables/ground_clc_banner.jpg
  :align: center
@@ -14,7 +14,7 @@ Table definition
 ---------------------
 
 .. warning::
- In the lists below, the two columns are mandatory
+ In the list below, the two columns are mandatory
 
 
 * ``THE_GEOM``
@@ -54,5 +54,3 @@ Topology
 ---------------------
 
 At a given point, there can only be one value of G. Consequently, in the ``GROUND`` table, the geometries must not overlap.
-
-

Docs/Input_railways.rst

@@ -5,7 +5,7 @@ NoiseModelling is a tool for producing noise maps. To do so, at different stages
 
 Below are described the tables ``RAIL_SECTIONS`` and ``RAIL_TRAFFIC``. 
 
-The other tables are accessible via the left menu in the ``Input tables`` section.
+The other tables are accessible via the left menu in the ``Input tables & parameters`` section.
 
 .. figure:: images/Input_tables/rails_banner.png
  :align: center

Docs/Input_receivers.rst

@@ -0,0 +1,82 @@
+Receivers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+NoiseModelling is a tool for producing noise maps. To do so, at different stages of the process, the application needs input data, respecting a strict formalism.
+
+Below we describe the table ``RECEIVERS``, dealing with the receivers. 
+
+The other tables are accessible via the left menu in the ``Input tables & parameters`` section.
+
+.. figure:: images/Input_tables/receivers_banner.png
+ :align: center
+
+
+Table definition
+********************
+
+.. warning::
+ The two following columns are mandatory
+
+* ``PK``
+ * Description: receiver's unique identifier. 
+ * Type: Integer - Primary Key
+* ``THE_GEOM``
+ * Description: 3D receiver's geometry. Z coordinate correspond to the receiver's altitude 
+ * Type: Geometry (``POINT`` or ``MULTIPOINT``)
+
+If you are working with receivers based on buildings (*e.g* 50 cm around the building's facades - see ``Building_grid`` script), your ``RECEIVERS`` table will need this additional column:
+
+* ``BUILD_PK``
+ * Description: building's Primary Key (``PK``), allowing to link the receivers with their building
+ * Type: Integer
+
+
+Parameters
+********************
+
+Below are listed the most important input parameters that may be found in the scripts dealing with receivers generation (*e.g* ``Building_grid``, ``Delaunay_grid``, ...) (see ``Receivers`` section in the left-side menu of NoiseModelling).
+
+These parameters can be mandatory or optional. When necessary, we indicates the default values and those we recommend (from an acoustic point of view).
+
+Maximum area
+-------------------------
+
+* Parameter name: ``maxArea``
+* Description: Set Maximum Area. No triangles larger than the provided area will be created. Smaller area will create more receivers (square meters)
+* Type: Double
+* Default value: ``2500``
+* Recommanded value: ``2500``
+
+.. figure:: images/Input_tables/receivers_maxArea.png
+ :align: center
+
+Maximum cell size
+--------------------------------
+
+* Parameter name: ``maxCellDist``
+* Description: Maximum distance used to split the domain into sub-domains. In a logic of optimization of processing times, it allows to limit the number of objects (buildings, roads, ...) stored in memory during the Delaunay triangulation (meters)
+* Type: Double
+* Default value: ``600``
+* Recommanded value: 
+
+.. figure:: images/Input_tables/receivers_maxCellDist.png
+ :align: center
+
+
+Road width
+--------------------------------
+
+* Parameter name: ``roadWidth``
+* Description: Set Road Width. No receivers closer than road width distance will be created (meters)
+* Type: Double
+* Default value: ``2``
+* Recommanded value: 
+
+Height
+--------------------------------
+
+* Parameter name: ``height``
+* Description: Receiver height relative to the ground (meters)
+* Type: Double
+* Default value: ``4``
+* Recommanded value: 

Docs/Input_roads.rst

@@ -5,7 +5,7 @@ NoiseModelling is a tool for producing noise maps. To do so, at different stages
 
 Below we describe the table ``ROADS``, dealing with the roads network. 
 
-The other tables are accessible via the left menu in the ``Input tables`` section.
+The other tables are accessible via the left menu in the ``Input tables & parameters`` section.
 
 .. figure:: images/Input_tables/roads_banner.png
  :align: center