5.x acoustic tests

.github/workflows/CI.yml

@@ -47,7 +47,7 @@ jobs:
       - name: Unzip production artifacts
         run: cd wps_scripts && ./gradlew assembleDist && unzip build/distributions/scriptrunner.zip
       - name: Archive production artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name:  NoiseModelling_without_gui.zip
-          path: wps_scripts/scriptrunner/
+          path: wps_scripts/scriptrunner/

.github/workflows/javaDoc.yml

@@ -0,0 +1,31 @@
+name: Generate and Deploy Javadoc
+
+on:
+  push:
+    branches:
+      - 4.XDebugTests
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+          cache: maven
+
+      - name: Build project and generate Javadoc
+        run: mvn clean javadoc:aggregate
+
+      - name: Deploy Javadoc to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./target/site/apidocs

.gitignore

@@ -5,6 +5,7 @@ nbactions.xml
 *.versionsBackup
 .attach*
 Docs/build
+Docs/.build
 Docs/venv
 profile_*.csv
 venv/

Docs/Architecture.rst

@@ -23,7 +23,7 @@ The documentation below presents the architecture of NoiseModelling with its dif
 NoiseModelling is made of 4 main `librairies`_: 
 
 * ``noisemodelling-emission`` : to determine the noise emission
-* ``noisemodelling-pathfinder`` : to determine the noise path 
+* ``noisemodelling-pathfinder`` : to determine the noise path
 * ``noisemodelling-propagation`` : to calculate the noise propagation
 * ``noisemodelling-jdbc`` : to connect NoiseModelling to a database
 

Docs/Get_Started_Dev.rst

@@ -9,7 +9,7 @@ Get Started
 
     * ``noisemodelling-emission`` : to determine the noise emission
     * ``noisemodelling-jdbc`` : to connect NoiseModelling to a database
-    * ``noisemodelling-pathfinder`` : to determine the noise path 
+    * ``noisemodelling-pathfinder`` : to determine the noise path
     * ``noisemodelling-propagation`` : to calculate the noise propagation
 
 #. Enjoy & feel free to contact us!

Docs/Input_buildings.rst

@@ -93,7 +93,7 @@ Below is an example with a initial geometry (coordinates are exprimed in French
 
 .. _EPSG:2154 : https://epsg.io/2154
 
-Ray path 
+Ray path
 -----------------------
 
 Depending on the building modelisation and the ``Zobject`` you have, the acoustic wave path will differ.

Docs/Noise_Map_From_Point_Source.rst

@@ -165,7 +165,7 @@ Use the ``NoiseModelling:Noise_level_from_source`` WPS script. Fill the three fo
 * ``Buildings table name`` : ``BUILDINGS``
 
 .. warning::
-   For this example, since we only added information for noise level during the day (field ``LWD500``), we have to skip the noise level calculation for LDEN, LNIGHT and LEVENING. To do so, check the boxes for ``Do not compute LDEN_GEOM``, ``Do not compute LEVENING_GEOM`` and ``Do not compute LNIGHT_GEOM`` options.
+   For this example, since we only added information for noise level during the day (field ``LWD500``), we have to skip the noise level calculation for AttenuatedPaths, LNIGHT and LEVENING. To do so, check the boxes for ``Do not compute LDEN_GEOM``, ``Do not compute LEVENING_GEOM`` and ``Do not compute LNIGHT_GEOM`` options.
 
 Once ready, click on ``Run Process`` button.
 

Docs/Numerical_Model.rst

@@ -23,7 +23,7 @@ User can also add directly its own emission sound power level (LW).
 
 Path finding algorithm
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The path finding algorithm is a rubber-band like algorithm as specified in `CNOSSOS-EU`_. 
+The path finding algorithm is a rubber-band like algorithm as specified in `CNOSSOS-EU`_.
 
 To optimize the processing time, this algorithm is taking benefit from a R-Tree spatial partioning algorithm.
 

Docs/Rapport.rst

@@ -0,0 +1,154 @@
+Final results
+================
+
+.. list-table:: Tests list
+   :widths: 10 20 20 25 30
+
+   * - Test Case
+     - Without lateral diffraction
+       - Yes/No
+     - With lateral diffraction
+       - Yes/No
+     - Largest Deviation
+       - dB / Hz
+     - Details
+   * - TC01
+     - Yes
+     - Yes
+     - 0.0 / 2000
+     - :doc:`Detail <TC01_D>`
+   * - TC02
+     - Yes
+     - Yes
+     - 0.07 / 1000
+     - :doc:`Detail <TC02_D>`
+   * - TC03
+     - Yes
+     - Yes
+     - 0.05 / 500
+     - :doc:`Detail <TC03_D>`
+   * - TC04
+     - Yes
+     - Yes
+     - 0.07 / 1000
+     - :doc:`Detail <TC04_D>`
+   * - TC05
+     - Yes
+     - Yes
+     - 0.0 / 1000
+     - :doc:`Detail <TC05_D>`
+   * - TC06
+     - Yes
+     - Yes
+     - 0.06 / 500
+     - :doc:`Detail <TC06_D>`
+   * - TC07
+     - Yes
+     - Yes
+     - 0.02 / 1000
+     - :doc:`Detail <TC07_D>`
+   * - TC08
+     - Yes
+     - Yes
+     - 0.02 / 1000
+     - :doc:`Detail <TC08_D>`
+   * - TC09
+     - Yes
+     - Yes
+     - 0.0 / 8000
+     - :doc:`Detail <TC09_D>`
+   * - TC10
+     - Yes
+     - Yes
+     - 0.0 / 500
+     - :doc:`Detail <TC10_D>`
+   * - TC11
+     - Yes
+     - Yes
+     - 0.0 / 4000
+     - :doc:`Detail <TC11_D>`
+   * - TC12
+     - Yes
+     - Yes
+     - 0.02 / 250
+     - :doc:`Detail <TC12_D>`
+   * - TC13
+     - Yes
+     - Yes
+     - 0.01 / 500
+     - :doc:`Detail <TC13_D>`
+   * - TC14
+     - Yes
+     - Yes
+     - 0.05 / 1000
+     - :doc:`Detail <TC14_D>`
+   * - TC15
+     - Yes
+     - Yes
+     - 0.0 / 500
+     - :doc:`Detail <TC15_D>`
+   * - TC16
+     - Yes
+     - Yes
+     - 0.02 / 63
+     - :doc:`Detail <TC16_D>`
+   * - TC17
+     - Yes
+     - No
+     - 0.86 / 500
+     - :doc:`Detail <TC17_D>`
+   * - TC18
+     - No
+     - No
+     - 0.45 / 125
+     - :doc:`Detail <TC18_D>`
+   * - TC19
+     - No
+     - No
+     - 0.95 / 250
+     - :doc:`Detail <TC19_D>`
+   * - TC20
+     - Yes
+     - Yes
+     - 0.0 / 8000
+     - :doc:`Detail <TC20_D>`
+   * - TC21
+     - No
+     - No
+     - 1.25 / 63
+     - :doc:`Detail <TC21_D>`
+   * - TC22
+     - No
+     - No
+     - 1.01 / 4000
+     - :doc:`Detail <TC22_D>`
+   * - TC23
+     - No
+     - No
+     - 2.13 / 4000
+     - :doc:`Detail <TC23_D>`
+   * - TC24
+     - No
+     - No
+     - 5.53 / 250
+     - :doc:`Detail <TC24_D>`
+   * - TC25
+     - No
+     - No
+     - 6.32 / 250
+     - :doc:`Detail <TC25_D>`
+   * - TC26
+     - No
+     - No
+     - 6.83 / 2000
+     - :doc:`Detail <TC26_D>`
+   * - TC27
+     - No
+     - No
+     - 5.92 / 500
+     - :doc:`Detail <TC27_D>`
+   * - TC28
+     - No
+     - No
+     - 61.99 / 250
+     - :doc:`Detail <TC28_D>`

Docs/TC01_D.rst

@@ -0,0 +1,48 @@
+TC01
+================
+
+.. list-table::
+   :widths: 25 25 25
+
+   * - Parameters
+     - Maximum Difference
+     - Frequency
+   * - WH
+     - 0.0
+     - 63
+   * - CfH
+     - 0.0
+     - 63
+   * - AGroundH
+     - 0.0
+     - 63
+   * - WF
+     - 0.0
+     - 63
+   * - CfF
+     - 0.0
+     - 63
+   * - AGroundF
+     - 0.0
+     - 63
+   * - AlphaAtm
+     - 0.0
+     - 2000
+   * - AAtm
+     - 0.0
+     - 500
+   * - ADiv
+     - 0.0
+     - 63
+   * - ABoundaryH
+     - 0.0
+     - 63
+   * - ABoundaryF
+     - 0.0
+     - 63
+   * - LH
+     - 0.0
+     - 1000
+   * - LF
+     - 0.0
+     - 500

Docs/TC02_D.rst

@@ -0,0 +1,48 @@
+TC02
+================
+
+.. list-table::
+   :widths: 25 25 25
+
+   * - Parameters
+     - Maximum Difference
+     - Frequency
+   * - WH
+     - 0.0
+     - 4000
+   * - CfH
+     - 0.0
+     - 1000
+   * - AGroundH
+     - 0.05
+     - 1000
+   * - WF
+     - 0.0
+     - 4000
+   * - CfF
+     - 0.0
+     - 1000
+   * - AGroundF
+     - 0.06
+     - 1000
+   * - AlphaAtm
+     - 0.0
+     - 2000
+   * - AAtm
+     - 0.0
+     - 500
+   * - ADiv
+     - 0.0
+     - 63
+   * - ABoundaryH
+     - 0.05
+     - 1000
+   * - ABoundaryF
+     - 0.06
+     - 1000
+   * - LH
+     - 0.05
+     - 1000
+   * - LF
+     - 0.07
+     - 1000

Docs/TC03_D.rst

@@ -0,0 +1,48 @@
+TC03
+================
+
+.. list-table:: Details of TC03
+   :widths: 25 25 25
+
+   * - Parameters
+     - Maximum Difference
+     - Frequency
+   * - WH
+     - 0.0
+     - 8000
+   * - CfH
+     - 0.0
+     - 2000
+   * - AGroundH
+     - 0.08
+     - 1000
+   * - WF
+     - 0.0
+     - 250
+   * - CfF
+     - 0.0
+     - 2000
+   * - AGroundF
+     - 0.05
+     - 500
+   * - AlphaAtm
+     - 0.0
+     - 2000
+   * - AAtm
+     - 0.0
+     - 500
+   * - ADiv
+     - 0.0
+     - 63
+   * - ABoundaryH
+     - 0.08
+     - 1000
+   * - ABoundaryF
+     - 0.05
+     - 500
+   * - LH
+     - 0.08
+     - 1000
+   * - LF
+     - 0.05
+     - 500