Merge pull request #86 from master-csmi/8-final-report

V2.1
master-csmi · Jun 3, 2024 · 54124cc · 54124cc
2 parents 6980876 + 97645c2
commit 54124cc
Show file tree

Hide file tree

Showing 72 changed files with 243 additions and 151 deletions.
diff --git a/.gitattributes b/.gitattributes
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,6 +1,6 @@
 name: C/C++ CI
 
-on: [pull_request, push]
+on: [pull_request]
 
 jobs:
   build:
@@ -49,5 +49,10 @@ jobs:
           cd build
           cmake --build . -- -j2  # Adjust the number of parallel jobs
 
+      - name: Run tests
+        run: |
+          cd build
+          ctest --output-on-failure
+
       - name: Display build directory contents
         run: ls -la build
diff --git a/.github/workflows/latex.yml b/.github/workflows/latex.yml
@@ -6,7 +6,14 @@ jobs:
     steps:
       - name: Set up Git repository
         uses: actions/checkout@v4
+
       - name: Compile LaTeX document
         uses: xu-cheng/latex-action@v3
         with:
           root_file: report.tex
+
+      - name: Upload PDF artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: report
+          path: report.pdf
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,6 @@ temp/
 .DS_Store
 
 query_result.json
+
+report.synctex(busy)
+presentation.synctex(busy)
diff --git a/Dockerfile b/Dockerfile
@@ -6,6 +6,10 @@ WORKDIR /workspace
 # Set the timezone
 ENV TZ=Europe/Paris
 
+# Install Git LFS
+RUN apt-get update && apt-get install -y git-lfs \
+	&& git lfs install
+
 # Install dependencies
 RUN apt-get update && apt-get install -y \
 	build-essential \
@@ -26,3 +30,6 @@ RUN git clone https://github.com/CGAL/cgal.git /workspace/cgal \
 # Copy the project files into the container
 COPY . /workspace/2024-m1-vegetation
 
+# Set the working directory to the project directory
+WORKDIR /workspace/2024-m1-vegetation
+
diff --git a/README.adoc b/README.adoc
@@ -2,15 +2,21 @@
 
 == Overview
 
-The goal of this project is to develop a tool that integrates vegetation (trees) into 3D urban models in order to improve the efficiency of thermal simulations.
+The goal of this project is to develop a tool that integrates trees into 3D urban models to improve the efficiency of thermal simulations. This project is part of the https://www.hidalgo2.eu[HiDALGO2] initiative, which aims to explore synergies between modeling, data acquisition, simulation, data analysis and visualization, with focus on improving building energy efficiency and indoor air quality.
 
 == Installation and Usage
 
 === Required Packages
 
-To build the project, you either need the following packages or you can use the Docker container provided in the repository:
+To build the project, you either need the following packages or you can use the provided Docker container:
 
-- https://www.cgal.org/[CGAL] (master), https://cmake.org/[CMake] (>= 3.15), https://git-scm.com/[Git], https://www.boost.org/[Boost], https://fmt.dev/[fmt], https://www.mpfr.org/[MPFR], https://curl.se/[libcurl]
+- https://www.cgal.org/[CGAL] (master)
+- https://cmake.org/[CMake] (>= 3.15)
+- https://git-scm.com/[Git]
+- https://www.boost.org/[Boost]
+- https://fmt.dev/[fmt]
+- https://www.mpfr.org/[MPFR]
+- https://curl.se/[libcurl]
 
 === Installating package on Ubuntu
 
@@ -20,24 +26,26 @@ sudo apt-get install -y build-essential cmake git libmpfr-dev libboost-dev libcu
 ```
 
 === Install CGAL
-CGAL is a header-only library, so you don't need to build it. You just need to install the package. For our project, we need the master branch of CGAL.
+For our project, we need the master branch of CGAL:
 ```bash
 git clone --branch master https://github.com/CGAL/cgal.git
-cd cgal
-mkdir cgal.install
-cd cgal.install
-cmake -DCMAKE_INSTALL_PREFIX=path_to/cgal.install /path_to/cgal
+mkdir cgal.build
+cd cgal.build
+cmake -DCMAKE_INSTALL_PREFIX=path_to/cgal.install ../cgal
 make install
 ```
 
-=== Alternatively you can use a Docker container:
+=== Alternatively, using the Docker container:
+This container can be used for developpement, when building the image the project is copied in the container without building the project.
+
+
+You might want to remove the `build` directory before running (and closing) the container to avoid conflicts.
+
 ```bash
 docker build -t 2024m1vegetation:latest .
-docker run -it 2024m1vegetation:latest`
+docker run -it 2024m1vegetation:latest
 ```
 
-You might want to remove the `build` directory before running (and closing) the container to avoid conflicts.
-
 On VsCode you can use the Remote - Containers extension to reopen the project in a container.
 
 === Build the Project
@@ -52,41 +60,43 @@ make
 ctest
 ```
 
+Note : this is the path used in the Docker container, you might need to change it to your own path.
+
 === Usage
 
 Use the configuration file `config.json` to specify:
 
-- the bounding box `bbox` of the area of interest ("bottom latitude, bottom longitude, top latitude, top longitude")
+- `bbox`: The bounding box of the area of interest ("bottom latitude, bottom longitude, top latitude, top longitude")
 
-- the `origin` used in the conversion from latitude and longitude to Cartesian coordinates
+- `origin`: The origin used in the conversion from latitude and longitude to Cartesian coordinates
 
-- the level of detail `LOD` (0, 1, 2, 3) of the meshes
+- `LOD`: The level of detail (0, 1, 2, 3) of the meshes
 
-- the `altitude` of the ground 
+- `altitude`: The altitube of the area of interest (in meters)
 
-- the default height of the trees `default_height_range` (in meters) when the height is not available in the OpenStreetMap data
+- `default_height_range`: The default height of the trees (in meters) when the height is not available in the OpenStreetMap data
 
-- the default genus of the trees `default_genus` when the genus is not available in the OpenStreetMap data
+- `default_genus`: The default genus of the trees when the genus is not available in the OpenStreetMap data
 
-- the `input_building_mesh` file for making the union of the building with the trees
+- `input_building_mesh`: The input building mesh file for merging the buildings with the trees
 
-- if we merge the trees with the buildings or not with `merge_builtings_trees`
+- `merge_builtings_trees`: Boolean to merge the trees with the buildings or not
 
-- the base name of the output file `output_file` saved in the `/output` directory
+- `output_file`: The base name of the output file saved in the `/output` directory
 
 Use the `genus.json` file to specify the genus and height of the trees to be used in the simulation.
 
-- `known_genus` is a list of genus for which we have a base mesh
-- `cedrus_like` is a list of the genus for which the cedrus mesh model will be used
+- `known_genus`: A list of genera for which we have a base mesh
+- `cedrus_like`: A list of the genera for which the cedrus mesh model will be used
 - etc.
 
-If you wish you can mesh your own tree model using link:https://doc.cgal.org/latest/Alpha_wrap_3/index.html[CGAL Alpha Wrapper] by running:
+To mesh your own tree model using link:https://doc.cgal.org/latest/Alpha_wrap_3/index.html[CGAL Alpha Wrapper] run:
 
 ```bash
 ./build/wrap Genus.stl <alpha> <offset>
 ```
 
-and move the result to the `tree_ref` directory. Then add the genus to the `known_genus` in the `trees.json` file.
+Move the result to the `tree_ref` directory and add the genus to the `known_genus` in the `trees.json` file.
 
 Finnaly run the program:
 ```bash
@@ -95,10 +105,14 @@ Finnaly run the program:
 
 The output mesh and some metrics will be saved in the `/output` directory (which is automatically created if needed).
 
-You can visualize the output mesh with **Meshlab**, **Paraview** or any other mesh viewer. (Note: Meshlab does not work well with Wayland.)
+You can visualize the output mesh with **Meshlab**, **Paraview** or any other mesh viewer.
 
 
 == Contributors
 
 * https://github.com/GiulioCrp[GiulioCrp]
-* https://github.com/PA-Senger[PA-Senger]
+* https://github.com/PA-Senger[PA-Senger]
+
+== References
+
+For detailed information on the project's context, objectives, methodology, and implemenation, please refer to the accompanying report.
diff --git a/config.json b/config.json
@@ -3,7 +3,7 @@
   "origin": "48.583055227464364, 7.748664426560083",
   "altitude": 0,
   "LOD": 0,
-  "default_height_range": "3, 6",
+  "default_height_range": "3, 10",
   "default_genus": "Platanus",
   "input_building_mesh": "mesh_lod1.stl",
   "merge_buildings_trees": true,

diff --git a/images/SolarMask.mp4 b/images/SolarMask.mp4
diff --git a/images/WGS84_mean_Earth_radius.svg.png → images/WGS84-earth-radius.png b/images/WGS84_mean_Earth_radius.svg.png → images/WGS84-earth-radius.png
diff --git a/images/WGS_84_reference_frame.png → images/WGS84-frame.png b/images/WGS_84_reference_frame.png → images/WGS84-frame.png
diff --git a/images/alpha-wrapping_ball.jpg → images/alpha-wrapping-ball.jpg b/images/alpha-wrapping_ball.jpg → images/alpha-wrapping-ball.jpg
diff --git a/images/aw3_bike_lod.jpg → images/alpha-wrapping-bike.jpg b/images/aw3_bike_lod.jpg → images/alpha-wrapping-bike.jpg
diff --git a/images/aw3_steps.jpg → images/alpha-wrapping-steps.jpg b/images/aw3_steps.jpg → images/alpha-wrapping-steps.jpg
diff --git a/images/alpha-wrapping-2d.mp4 → images/alpha-wrapping.mp4 b/images/alpha-wrapping-2d.mp4 → images/alpha-wrapping.mp4
diff --git a/images/alpha-wrapping_alpha_offset.jpg b/images/alpha-wrapping_alpha_offset.jpg
diff --git a/images/alpha-wrapping_motor.jpg b/images/alpha-wrapping_motor.jpg
diff --git a/images/alpha-wrapping_motor.png b/images/alpha-wrapping_motor.png
diff --git a/images/area_vs_trees.png → images/bench-area-vs-trees.png b/images/area_vs_trees.png → images/bench-area-vs-trees.png
diff --git a/images/bench_ntree_nfaces.png → images/bench-ntree-nfaces.png b/images/bench_ntree_nfaces.png → images/bench-ntree-nfaces.png
diff --git a/images/bench_time_ntree.png → images/bench-time-ntree-linear.png b/images/bench_time_ntree.png → images/bench-time-ntree-linear.png
diff --git a/images/bench_time_ntree_quad.png → images/bench-time-ntree-quad.png b/images/bench_time_ntree_quad.png → images/bench-time-ntree-quad.png
diff --git a/images/bench_time_ntree_linear.png b/images/bench_time_ntree_linear.png
diff --git a/...es/Delaunay_circumcircles_centers.svg.png → images/delaunay-centers.png b/...es/Delaunay_circumcircles_centers.svg.png → images/delaunay-centers.png
diff --git a/.../Delaunay_circumcircles_vectorial.svg.png → images/delaunay-vectorial.png b/.../Delaunay_circumcircles_vectorial.svg.png → images/delaunay-vectorial.png
diff --git a/images/Delaunay_Voronoi.svg.png → images/delaunay-voronoi.png b/images/Delaunay_Voronoi.svg.png → images/delaunay-voronoi.png
diff --git a/images/feelpp.png b/images/feelpp.png
diff --git a/images/gingko_lod0.png → images/gingko-lod0.png b/images/gingko_lod0.png → images/gingko-lod0.png
diff --git a/images/gingko_lod1.png → images/gingko-lod1.png b/images/gingko_lod1.png → images/gingko-lod1.png
diff --git a/images/gingko_lod2.png → images/gingko-lod2.png b/images/gingko_lod2.png → images/gingko-lod2.png
diff --git a/images/gingko_lod3.png → images/gingko-lod3.png b/images/gingko_lod3.png → images/gingko-lod3.png
diff --git a/images/ginkgo_sketchup.png → images/ginkgo-sketchup.png b/images/ginkgo_sketchup.png → images/ginkgo-sketchup.png
diff --git a/images/heat_street.png → images/heat-street.png b/images/heat_street.png → images/heat-street.png
diff --git a/images/how-api-works.jpg b/images/how-api-works.jpg
diff --git a/images/lod_vs_faces.png b/images/lod_vs_faces.png
diff --git a/images/lod_vs_time.png b/images/lod_vs_time.png
diff --git a/images/cgal_logo.png → images/logo-cgal.png b/images/cgal_logo.png → images/logo-cgal.png
diff --git a/images/Curl-logo.svg.png → images/logo-curl.png b/images/Curl-logo.svg.png → images/logo-curl.png
diff --git a/images/hidalgo2.png → images/logo-hidalgo2.png b/images/hidalgo2.png → images/logo-hidalgo2.png
diff --git a/images/logo_irma.png → images/logo-irma.png b/images/logo_irma.png → images/logo-irma.png
diff --git a/images/osm_logo.png → images/logo-openstreetmap.png b/images/osm_logo.png → images/logo-openstreetmap.png
diff --git a/images/OvAPI_logo.png → images/logo-overpass.png b/images/OvAPI_logo.png → images/logo-overpass.png
diff --git a/images/logo_ufr.png → images/logo-ufr.png b/images/logo_ufr.png → images/logo-ufr.png
diff --git a/images/manhattan-mesh-1.png → images/mesh-manhattan-1.png b/images/manhattan-mesh-1.png → images/mesh-manhattan-1.png
diff --git a/images/manhattan-mesh-2.png → images/mesh-manhattan-2.png b/images/manhattan-mesh-2.png → images/mesh-manhattan-2.png
diff --git a/images/republic_lod3_side.png → images/mesh-republic-lod3-side.png b/images/republic_lod3_side.png → images/mesh-republic-lod3-side.png
diff --git a/images/republic_lod3.png → images/mesh-republic-lod3.png b/images/republic_lod3.png → images/mesh-republic-lod3.png
diff --git a/images/strasbourg_mesh_enhanced1.png → images/mesh-strasbourg-enhanced1.png b/images/strasbourg_mesh_enhanced1.png → images/mesh-strasbourg-enhanced1.png
diff --git a/images/strasbourg_mesh_enhanced2.png → images/mesh-strasbourg-enhanced2.png b/images/strasbourg_mesh_enhanced2.png → images/mesh-strasbourg-enhanced2.png
diff --git a/images/mesh_vs_overpass.png b/images/mesh_vs_overpass.png
diff --git a/images/meshlab_logo.png b/images/meshlab_logo.png
diff --git a/images/bbox1.png → images/ovt-bbox1.png b/images/bbox1.png → images/ovt-bbox1.png
diff --git a/images/bbox2.png → images/ovt-bbox2.png b/images/bbox2.png → images/ovt-bbox2.png
diff --git a/images/bbox3.png → images/ovt-bbox3.png b/images/bbox3.png → images/ovt-bbox3.png
diff --git a/images/bbox4.png → images/ovt-bbox4.png b/images/bbox4.png → images/ovt-bbox4.png
diff --git a/images/overpass-turbo.png → images/ovt-example.png b/images/overpass-turbo.png → images/ovt-example.png
diff --git a/images/republic_overpassturbo.png → images/ovt-republic.png b/images/republic_overpassturbo.png → images/ovt-republic.png
diff --git a/images/stras_mesh.png b/images/stras_mesh.png
diff --git a/images/thermographie-aerienne.jpg b/images/thermographie-aerienne.jpg
diff --git a/images/tractor.mp4 b/images/tractor.mp4
diff --git a/images/abies.png → images/tree-abies.png b/images/abies.png → images/tree-abies.png
diff --git a/images/acer.png → images/tree-acer.png b/images/acer.png → images/tree-acer.png
diff --git a/images/aesculus.png → images/tree-aesculus.png b/images/aesculus.png → images/tree-aesculus.png
diff --git a/images/catalpa.png → images/tree-catalpa.png b/images/catalpa.png → images/tree-catalpa.png
diff --git a/images/cedrus.png → images/tree-cedrus.png b/images/cedrus.png → images/tree-cedrus.png
diff --git a/images/liquidanbar.png → images/tree-liquidanbar.png b/images/liquidanbar.png → images/tree-liquidanbar.png
diff --git a/images/platanus.png → images/tree-platanus.png b/images/platanus.png → images/tree-platanus.png
diff --git a/images/quercus.png → images/tree-quercus.png b/images/quercus.png → images/tree-quercus.png
diff --git a/images/TreeShade.png → images/tree-shade.png b/images/TreeShade.png → images/tree-shade.png
diff --git a/images/tree_mesh.png b/images/tree_mesh.png