Skip to content

Commit 85c6680

Browse files
nicolas-fnicolas-f
authored
Merge pull request #931 from gpetit/add_functions
This PR propose to add the list of all functions into the Documentation
2 parents 99c0634 + 29c6de6 commit 85c6680

164 files changed

Lines changed: 5559 additions & 35422 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/CI.yml‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,21 @@ jobs:
6060
MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
6161
MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
6262
if: ${{ (env.MAVEN_USERNAME != null) && (github.ref == 'refs/heads/main') }}
63-
run: mvn clean deploy -B
64-
- name: Install bsdtar
65-
run: |
66-
sudo apt-get update
67-
sudo apt-get install -y libarchive-tools
63+
run: mvn clean -DskipTests deploy -B
6864
- name: Unzip production artifacts
6965
run: |
66+
# 1. Unzip into a temporary directory
67+
unzip -q noisemodelling-scripts/target/*.zip -d tmp_extract
68+
69+
# 2. Create target directory
7070
mkdir NoiseModelling
71-
# bsdtar handles .zip and supports --strip-components
72-
bsdtar -xvf noisemodelling-scripts/target/*.zip --strip-components=1 -C NoiseModelling
71+
72+
# 3. Move contents from the subfolder to the target
73+
# The asterisk-slash-asterisk moves everything inside the first subfolder
74+
mv tmp_extract/*/* NoiseModelling/
75+
76+
# 4. Cleanup
77+
rm -rf tmp_extract
7378
- name: Generate Sanitized Artifact Name
7479
id: sanitize
7580
run: |

‎.github/workflows/build_macos.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
name: Reusable macOS Build
22

33
on:
4+
workflow_dispatch:
5+
inputs:
6+
git_ref:
7+
description: 'The git ref to checkout'
8+
required: true
9+
type: string
410
workflow_call:
511
inputs:
612
git_ref:

‎.github/workflows/build_windows.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
name: Reusable Windows Build
22

33
on:
4+
workflow_dispatch:
5+
inputs:
6+
git_ref:
7+
description: 'The git ref to checkout'
8+
required: true
9+
type: string
410
workflow_call:
511
inputs:
612
git_ref:

‎Docs/Functions.rst‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
.. DO NOT UPDATE THIS FILE!!
2+
.. This document has been automatically generated with noisemodelling-scripts/src/main/java/org/noise_planet/noisemodelling/webserver/script/GenerateFunctionsDocs.java
3+
4+
List of functions
5+
^^^^^^^^^^^^^^^^^
6+
7+
Below is a list of all the functions that can be run in NoiseModelling.
8+
These functions, written as ``.groovy`` scripts, are available in the ``/scripts/`` folder.
9+
10+
Acoustic Tools
11+
~~~~~~~~~~~~~~
12+
13+
.. toctree::
14+
:maxdepth: 1
15+
16+
functions/Acoustic_Tools/Add_Laeq_Leq_columns
17+
functions/Acoustic_Tools/Create_Isolines
18+
functions/Acoustic_Tools/Create_Isosurface
19+
functions/Acoustic_Tools/DynamicIndicators
20+
21+
Data Assimilation
22+
~~~~~~~~~~~~~~~~~
23+
24+
.. toctree::
25+
:maxdepth: 1
26+
27+
functions/Data_Assimilation/All_Possible_Configuration
28+
functions/Data_Assimilation/Create_Assimilated_Maps
29+
functions/Data_Assimilation/Data_Simulation
30+
functions/Data_Assimilation/Extract_Best_Configuration
31+
functions/Data_Assimilation/Merged_Sensors_Receivers
32+
functions/Data_Assimilation/NMs_4_BestConfigs
33+
functions/Data_Assimilation/Prepare_Sensors
34+
35+
Database Manager
36+
~~~~~~~~~~~~~~~~
37+
38+
.. toctree::
39+
:maxdepth: 1
40+
41+
functions/Database_Manager/Add_Primary_Key
42+
functions/Database_Manager/Clean_Database
43+
functions/Database_Manager/Display_Database
44+
functions/Database_Manager/Drop_a_Table
45+
functions/Database_Manager/Table_Visualization_Data
46+
functions/Database_Manager/Table_Visualization_Map
47+
48+
Dynamic
49+
~~~~~~~
50+
51+
.. toctree::
52+
:maxdepth: 1
53+
54+
functions/Dynamic/Flow_2_Noisy_Vehicles
55+
functions/Dynamic/Ind_Vehicles_2_Noisy_Vehicles
56+
functions/Dynamic/Noise_From_Attenuation_Matrix
57+
functions/Dynamic/Point_Source_From_Network
58+
functions/Dynamic/Split_Sources_Period
59+
60+
Experimental
61+
~~~~~~~~~~~~
62+
63+
.. toctree::
64+
:maxdepth: 1
65+
66+
functions/Experimental/Noise_Map_Difference
67+
functions/Experimental/Road_Emission_From_AADF
68+
functions/Experimental/Road_Emission_From_TMJA
69+
70+
Experimental Matsim
71+
~~~~~~~~~~~~~~~~~~~
72+
73+
.. toctree::
74+
:maxdepth: 1
75+
76+
functions/Experimental_Matsim/Agent_Exposure
77+
functions/Experimental_Matsim/Import_Activities
78+
functions/Experimental_Matsim/Plot_Exposition_Distribution
79+
functions/Experimental_Matsim/Receivers_From_Activities_Closest
80+
functions/Experimental_Matsim/Receivers_From_Activities_Random
81+
functions/Experimental_Matsim/Traffic_From_Events
82+
83+
Geometric Tools
84+
~~~~~~~~~~~~~~~
85+
86+
.. toctree::
87+
:maxdepth: 1
88+
89+
functions/Geometric_Tools/Change_SRID
90+
functions/Geometric_Tools/Clean_Buildings_Table
91+
functions/Geometric_Tools/Enrich_DEM
92+
functions/Geometric_Tools/Enrich_DEM_with_lines
93+
functions/Geometric_Tools/Enrich_DEM_with_rail
94+
functions/Geometric_Tools/Enrich_DEM_with_road
95+
functions/Geometric_Tools/Enrich_Landcover_with_rail
96+
functions/Geometric_Tools/Point_Source_0dB_From_Network
97+
functions/Geometric_Tools/Screen_to_building
98+
functions/Geometric_Tools/Set_Height
99+
functions/Geometric_Tools/Simplify_Geometries
100+
101+
Import and Export
102+
~~~~~~~~~~~~~~~~~
103+
104+
.. toctree::
105+
:maxdepth: 1
106+
107+
functions/Import_and_Export/Export_Table
108+
functions/Import_and_Export/Import_Asc_File
109+
functions/Import_and_Export/Import_Asc_Folder
110+
functions/Import_and_Export/Import_File
111+
functions/Import_and_Export/Import_Folder
112+
functions/Import_and_Export/Import_OSM
113+
functions/Import_and_Export/Import_OSM_Pedestrian
114+
functions/Import_and_Export/Import_Symuvia
115+
functions/Import_and_Export/Linked_Table
116+
117+
NoiseModelling
118+
~~~~~~~~~~~~~~
119+
120+
.. toctree::
121+
:maxdepth: 1
122+
123+
functions/NoiseModelling/Atmospheric_Template
124+
functions/NoiseModelling/Noise_level_from_source
125+
functions/NoiseModelling/Noise_level_from_traffic
126+
functions/NoiseModelling/PlotDirectivity
127+
functions/NoiseModelling/Railway_Emission_from_Traffic
128+
functions/NoiseModelling/Road_Emission_from_Traffic
129+
130+
Receivers
131+
~~~~~~~~~
132+
133+
.. toctree::
134+
:maxdepth: 1
135+
136+
functions/Receivers/Building_Grid
137+
functions/Receivers/Building_Grid3D
138+
functions/Receivers/Delaunay_Grid
139+
functions/Receivers/Random_Grid
140+
functions/Receivers/Regular_Grid
141+

‎Docs/functions/Acoustic_Tools/Add_Laeq_Leq_columns.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.. DO NOT UPDATE THIS FILE!!
2+
.. This document has been automatically generated with noisemodelling-scripts/src/main/java/org/noise_planet/noisemodelling/webserver/script/GenerateFunctionsDocs.java
3+
4+
Add Laeq Leq columns
5+
====================
6+
7+
Add LAeq and Leq columns
8+
9+
Overview
10+
--------
11+
12+
➡️ Add the columns LAeq and Leq to a table with octave band values from 63 Hz to 8000 Hz.
13+
The columns of the table should be named HZ63, HZ125,..., HZ8000 with an HZ prefix that can be changed.
14+
15+
Arguments
16+
---------
17+
18+
Mandatory inputs
19+
~~~~~~~~~~~~~~~~
20+
21+
``prefix`` — *Prefix of the frequency bands column*
22+
Prefix of the columns containing the octave bands. (STRING) For example: HZ
23+
24+
Type: ``String``
25+
26+
``tableName`` — *Name of the table*
27+
Name of the table on which LAeq and Leq columns will be added.
28+
29+
Type: ``String``
30+
31+
Output
32+
------
33+
34+
``result`` — *Result output string*
35+
This type of result does not allow the blocks to be linked together.
36+
37+
Type: ``String``
38+

‎Docs/functions/Acoustic_Tools/Create_Isolines.rst‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.. DO NOT UPDATE THIS FILE!!
2+
.. This document has been automatically generated with noisemodelling-scripts/src/main/java/org/noise_planet/noisemodelling/webserver/script/GenerateFunctionsDocs.java
3+
4+
Create Isolines
5+
===============
6+
7+
Overview
8+
--------
9+
10+
Generate isolines (isophones) by linear interpolation on triangle edges (marching-triangles). One multilines map per PERIOD and per LEVEL is created. Main output table : ISOLINES_NOISE_MAP with : - PERIOD : receivers period label (VARCHAR). - LEVEL : isoline value (DOUBLE). - THE_GEOM : MULTILINESTRING/LINESTRING geometry. Additional output tables : one table per PERIOD, named L<PERIOD>_ISOLINES_NOISE_MAP, containing only the isolines of that PERIOD (same structure as above).
11+
12+
Arguments
13+
---------
14+
15+
Mandatory inputs
16+
~~~~~~~~~~~~~~~~
17+
18+
``receiversTable`` — *Receivers level table*
19+
Name of the receivers level table.Shall contain : IDRECEIVER, PERIOD, THE_GEOM, LAEQ (or any field to contour).
20+
21+
Type: ``String``
22+
23+
``trianglesTable`` — *Triangles table*
24+
Name of the triangles table.Shall contain : PK, THE_GEOM, PK_1, PK_2, PK_3, CELL_ID.
25+
26+
Type: ``String``
27+
28+
Optional inputs
29+
~~~~~~~~~~~~~~~
30+
31+
``fieldName`` — *Field to contour*
32+
Receivers numeric field to contour (e.g. LAEQ).
33+
34+
Type: ``String``
35+
36+
Default: ``LAEQ``
37+
38+
``isoClasses`` — *Iso levels (dB)*
39+
Comma-separated levels.
40+
41+
Type: ``String``
42+
43+
Default: ``35.0,40.0,45.0,50.0,55.0,60.0,65.0,70.0,75.0,80.0,200.0``
44+
45+
Output
46+
------
47+
48+
``result`` — *Result output string*
49+
This type of result does not allow the blocks to be linked together.
50+
51+
Type: ``String``
52+

‎Docs/functions/Acoustic_Tools/Create_Isosurface.rst‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
.. DO NOT UPDATE THIS FILE!!
2+
.. This document has been automatically generated with noisemodelling-scripts/src/main/java/org/noise_planet/noisemodelling/webserver/script/GenerateFunctionsDocs.java
3+
4+
Create Isosurface
5+
=================
6+
7+
Create isosurfaces from a NoiseModelling resulting table and its associated TRIANGLES table.
8+
9+
Overview
10+
--------
11+
12+
➡️ Create isosurfaces from a NoiseModelling resulting table and its associated TRIANGLES table.
13+
🚨 The triangle table must have been created using the "Receivers/Delaunay_Grid" WPS block. ✅ The output table is called CONTOURING_NOISE_MAP
14+
15+
.. figure:: create_isosurface.png
16+
:align: center
17+
:alt: Create isosurfaces
18+
19+
Arguments
20+
---------
21+
22+
Mandatory inputs
23+
~~~~~~~~~~~~~~~~
24+
25+
``resultTable`` — *Sound levels table*
26+
Name of the sound levels table, generated from the "Noise_level_from_source" WPS block. (STRING) Example : RECEIVERS_LEVEL
27+
28+
Type: ``String``
29+
30+
Optional inputs
31+
~~~~~~~~~~~~~~~
32+
33+
``isoClass`` — *Iso levels in dB*
34+
Separation of sound levels for isosurfaces. The first range is from -∞ to the first value (excluded). The next range is from the first value (included) to the next value (excluded). Read this documentation for more information about sound levels classes.
35+
36+
Type: ``String``
37+
38+
Default: ``35.0,40.0,45.0,50.0,55.0,60.0,65.0,70.0,75.0,80.0,200.0``
39+
40+
``keepTriangles`` — *Keep triangles*
41+
Point inside areas with the same iso levels are kept so elevation variation into same iso level areas will be preserved but the output data size will be higher. Keeping triangles will reduce significantly the computation time.
42+
43+
Type: ``Boolean``
44+
45+
Default: ``false``
46+
47+
``resultTableField`` — *Field of result table*
48+
Field to read in the result table to make the iso surface.
49+
50+
Type: ``String``
51+
52+
Default: ``LAEQ``
53+
54+
``smoothCoefficient`` — *Polygon smoothing coefficient*
55+
This coefficient (Bezier curve coefficient) will smooth the generated isosurfaces. If equal to 0, it disables the smoothing step and will keep the altitude of final polygons (3D geojson can be viewed on https://kepler.gl).Use this option with keepTriangles to keep the altitude variation into same iso level areas.
56+
57+
Type: ``Double``
58+
59+
Default: ``0``
60+
61+
Output
62+
------
63+
64+
``result`` — *Output table*
65+
Name of the output table containing the isosurfaces. The table is created in the same schema as the input result table. (STRING)
66+
67+
Type: ``String``
68+

0 commit comments

Comments
 (0)