Change Python to src, modify doc and format code

Author: MatRouillard

Documentation/dev-doc.md

@@ -50,6 +50,8 @@ The database used in this repository is:
 - `user`: `postgres`
 - `password`: `postgres`
 
+These information can be changed by modifying the [.env](../.env) file directly.
+
 ### Common model
 
 To compare OSM and OMF data, a common model was created (for transportation data), mainly based on the OMF transportation model. The model is as follows:
@@ -106,7 +108,7 @@ CREATE SCHEMA IF NOT EXISTS omf;
 CREATE SCHEMA IF NOT EXISTS results;
 ```
 
-*Note*: It is sufficient to create the database, as in the [data_integration.py](../Python/Assessment/data_integration.py#L24), these SQL commands are executed (inside the `utils.initialisePostgreSQL(connection)` function).
+*Note*: It is sufficient to create the database, as in the [data_integration.py](../src/Assessment/data_integration.py#L24), these SQL commands are executed (inside the `utils.initialisePostgreSQL()` function).
 
 ## Python
 
@@ -214,7 +216,7 @@ In the Python files, the database connection can take one of three forms:
 
 - `initialiseDuckDB()`: Initializes DuckDB and connects it to a PostgreSQL database.
 
-These functions are defined in the [utils.py](../Python/Utils/utils.py) script.
+These functions are defined in the [utils.py](../src/Utils/utils.py) script.
 They require one argument, a path to a `.env` file. If no path is provided, the default path will be:
 
 ```python
@@ -242,14 +244,14 @@ The same environment file is used for the data integration, quality assessment,
 
 ## Download and Process Data
 
-Data corresponding to the chosen areas can be downloaded using the [data_integration.py](../Python/Assessment/data_integration.py) script.
+Data corresponding to the chosen areas can be downloaded using the [data_integration.py](../src/Assessment/data_integration.py) script.
 Certain attribute values in this file can be modified, such as:
 
-- [`createBoundingBoxTable`](../Python/Assessment/data_integration.py#L19): If `True`, it will create the bounding box table, even if it has already been created. Defaults to `True`.
+- [`createBoundingBoxTable`](../src/Assessment/data_integration.py#L20): If `True`, it will create the bounding box table, even if it has already been created. Defaults to `True`.
 
-- [`skip<theme>Check`](../Python/Assessment/data_integration.py#L57): If `True`, it will recreate all layers of each area for the specified theme (one of `Graph`, `Building`, or `Place`). Otherwise, layers will be created only if they have not been created yet. Defaults to `False`.
+- [`skip<theme>Check`](../src/Assessment/data_integration.py#L58): If `True`, it will recreate all layers of each area for the specified theme (one of `Graph`, `Building`, or `Place`). Otherwise, layers will be created only if they have not been created yet. Defaults to `False`.
 
-- [`ox.settings.overpass_settings`](../Python/Assessment/data_integration.py#L37): This setting is used to limit OSM data to a specific date. The default date is `2024-06-07T23:59:59Z`. This date can be changed if desired, but it is preferable to select a date approximately the same as the one used by the `overturemaps.py` tool (the default date corresponds to the 2024-06-13-beta.1 release).
+- [`ox.settings.overpass_settings`](../src/Assessment/data_integration.py#L38): This setting is used to limit OSM data to a specific date. The default date is `2024-06-07T23:59:59Z`. This date can be changed if desired, but it is preferable to select a date approximately the same as the one used by the `overturemaps.py` tool (the default date corresponds to the 2024-06-13-beta.1 release).
 
 Normally, no additional changes should be necessary (such as altering template names for the layer, schema names, or the path to the bbox file, etc.).
 If changes are required, they should be made consistently across the different files.
@@ -265,15 +267,15 @@ Or directly by running the script in an IDE of choice.
 ## Quality Assessment Criteria
 
 Once the data has been downloaded, the necessary scripts can be run to assess the quality of the different layers.
-Currently, the criteria are focused on graph data. The Python script is [quality_assessment.py](../Python/Assessment/quality_assessment.py), that uses the function in the [quality.py](../Python/Assessment/quality.py) script.
+Currently, the criteria are focused on graph data. The Python script is [quality_assessment.py](../src/Assessment/quality_assessment.py), that uses the function in the [quality.py](../src/Assessment/quality.py) script.
 
 Certain attribute values can be modified, such as:
 
-- [`fileName`](../Python/Assessment/quality_assessment.py#L21): The name of the markdown file that will be produced. Defaults to `Automatic_result.md`.
+- [`fileName`](../src/Assessment/quality_assessment.py#L20): The name of the markdown file that will be produced. Defaults to `Automatic_result.md`.
 
-- [`pathSave`](../Python/Assessment/quality_assessment.py#L23): The path to save the markdown file. If the folder does not exist, an error will be returned. Defaults to `./Data/Results/<fileName>`, where `<fileName>` is the previously mentioned variable.
+- [`pathSave`](../src/Assessment/quality_assessment.py#L22): The path to save the markdown file. If the folder does not exist, an error will be returned. Defaults to `./Data/Results/<fileName>`, where `<fileName>` is the previously mentioned variable.
 
-- [`bounding_box_table`](../Python/Assessment/quality_assessment.py#60): The name of the bounding box table in the public schema of the database. Defaults to `bounding_box`.
+- [`bounding_box_table`](../src/Assessment/quality_assessment.py#L59): The name of the bounding box table in the public schema of the database. Defaults to `bounding_box`.
 
 Other variables can also be changed, but this is not recommended, especially since changes would need to be updated in the dashboard as well.
 
@@ -300,4 +302,4 @@ Then, open your browser and navigate to [http://127.0.0.1:8000](http://127.0.0.1
 
 ## Use the Application
 
-To use the application, refer to the `Help` panel within the application or consult the [help.md](../Python/GeoDataCompare/help.md) file directly.
+To use the application, refer to the `Help` panel within the application or consult the [help.md](../src/GeoDataCompare/help.md) file directly.

Documentation/user-doc.md

@@ -121,12 +121,12 @@ python Python\Assessment\data_integration.py
 
 It uses the file containing the bounding box: [bboxs.json](./Data/bboxs.json).
 Refer to the [user documentation](./Documentation/user-doc.md#adding-areas) for more information about how to add new areas.
-You will also find information about how to configurate the [data_integration.py](Python/Assessment/data_integration.py/) file for forcing the data download or preventing the bounding box table to be recreated again.
+You will also find information about how to configurate the [data_integration.py](src/Assessment/data_integration.py/) file for forcing the data download or preventing the bounding box table to be recreated again.
 
 ## Quality assessment
 
 This script needs to be run after the data integration process, but before running the DashBoard.
-It is contained in the [quality_assessment.py](./Python/Assessment/quality_assessment.py)
+It is contained in the [quality_assessment.py](./src/Assessment/quality_assessment.py)
 To run this script:
 
 ```cmd

Readme.md

@@ -1,13 +1,14 @@
 import sys
 import os
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..')))
-from Python.Utils import utils
-from Python.Assessment import osm
-from Python.Assessment import omf
+from src.Utils import utils
+from src.Assessment import osm
+from src.Assessment import omf
 import osmnx as ox
 import time
 import json
 
+sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..")))
+
 
 # Number of seconds in total
 total = 0
@@ -34,7 +35,9 @@
     print("The bounding box table was not created")
 
 # Limit date of data
-ox.settings.overpass_settings = '[out:json][timeout:{timeout}]{maxsize}[date:"2024-08-31T23:59:59Z"]'
+ox.settings.overpass_settings = (
+    '[out:json][timeout:{timeout}]{maxsize}[date:"2024-08-31T23:59:59Z"]'
+)
 
 curdir = os.getcwd()
 
@@ -67,105 +70,111 @@
     # Get the element we need from the json
     bbox = elem["bbox"]
     area = elem["area"].lower()
-    
+
     print(f"Start process {area.capitalize()}")
-    
+
     ## Insert bounding box
-    # Tranform bbox to OGC WKT format and insert into bounding box table 
+    # Tranform bbox to OGC WKT format and insert into bounding box table
     wktGeom = utils.bboxCSVToBboxWKT(bbox)
 
     # Insert bbox in bounding box table
     utils.insertBoundingBox(
-        connection = connection,
-        wktGeom = wktGeom,
-        aeraName = area.capitalize(),
-        tableName = "bounding_box")
-    
+        connection=connection,
+        wktGeom=wktGeom,
+        aeraName=area.capitalize(),
+        tableName="bounding_box",
+    )
+
     end = time.time()
     print(f"Insert bounding box of {area}: {end - start} seconds")
-    
+
     print()
-    
+
     ### Places ###
     ## OMF
     # Check if the process has already been done
-    if not utils.isProcessAlreadyDone(connection, placeTable.format(area), schema_omf, skipPlaceCheck):
-    
+    if not utils.isProcessAlreadyDone(
+        connection, placeTable.format(area), schema_omf, skipPlaceCheck
+    ):
+
         omf.createPlaceFromBbox(
-            bbox = bbox,
-            savePathFolder = folderSave,
-            area = area,
-            schema = schema_omf
+            bbox=bbox, savePathFolder=folderSave, area=area, schema=schema_omf
         )
-        
+
         end = time.time()
         print(f"OMF places of {area}: {end - start} seconds")
-    
+
     else:
         print("OMF places already downloaded")
-    
+
     ## OSM
     # Check if the process has already been done
-    if not utils.isProcessAlreadyDone(connection, placeTable.format(area), schema_osm, skipPlaceCheck):
-    
+    if not utils.isProcessAlreadyDone(
+        connection, placeTable.format(area), schema_osm, skipPlaceCheck
+    ):
+
         osm.createPlaceFromBbox(
-            connection = connection,
-            engine = engine,
-            bbox = bbox,
-            area = area,
-            schema = schema_osm
+            connection=connection,
+            engine=engine,
+            bbox=bbox,
+            area=area,
+            schema=schema_osm,
         )
-        
+
         end = time.time()
         print(f"OSM places of {area}: {end - start} seconds")
-    
+
     else:
         print("OSM places already downloaded")
-    
+
     print()
-    
+
     ### Buildings ###
     ## OMF
     # Check if the process has already been done
-    if not utils.isProcessAlreadyDone(connection, buildingTable.format(area), schema_omf, skipBuildingCheck):
-    
+    if not utils.isProcessAlreadyDone(
+        connection, buildingTable.format(area), schema_omf, skipBuildingCheck
+    ):
+
         omf.createBuildingFromBbox(
-            bbox = bbox,
-            savePathFolder = folderSave,
-            area = area,
-            schema = schema_omf
+            bbox=bbox, savePathFolder=folderSave, area=area, schema=schema_omf
         )
-        
+
         end = time.time()
         print(f"OMF buildings of {area}: {end - start} seconds")
-    
+
     else:
         print("OMF buildings already downloaded")
-    
+
     ## OSM
     # Check if the process has already been done
-    if not utils.isProcessAlreadyDone(connection, buildingTable.format(area), schema_osm, skipBuildingCheck):
-    
+    if not utils.isProcessAlreadyDone(
+        connection, buildingTable.format(area), schema_osm, skipBuildingCheck
+    ):
+
         osm.createBuildingFromBbox(
-            engine = engine,
-            bbox = bbox,
-            area = area,
-            schema = schema_osm
+            engine=engine, bbox=bbox, area=area, schema=schema_osm
         )
-        
+
         end = time.time()
         print(f"OSM buildings of {area}: {end - start} seconds")
-    
+
     else:
         print("OSM buildings already downloaded")
-    
+
     print()
-    
+
     ### Graph ###
     ## OMF
     # Check if the process has already been done
-    if not (utils.isProcessAlreadyDone(connection, edgeTable.format(area), schema_omf, skipGraphCheck) and
-            utils.isProcessAlreadyDone(connection, nodeTable.format(area), schema_omf, True)):
+    if not (
+        utils.isProcessAlreadyDone(
+            connection, edgeTable.format(area), schema_omf, skipGraphCheck
+        )
+        and utils.isProcessAlreadyDone(
+            connection, nodeTable.format(area), schema_omf, True
+        )
+    ):
 
         # # Old version
         # omf.createGraphFromBbox(
@@ -175,46 +184,52 @@
         #     connection = connection,
         #     schema = schema_omf
         # )
-        
+
         # New version
         omf.createGraphFromBboxNewVersion(
             bbox=bbox,
             savePathFolder=folderSave,
             area=area,
             connection=connection,
-            schema=schema_omf
+            schema=schema_omf,
         )
-        
+
         end = time.time()
         print(f"OMF graph of {area}: {end - start} seconds")
-    
+
     else:
         print("OMF graph already downloaded")
-    
+
     ## OSM
     # Check if the process has already been done
-    if not (utils.isProcessAlreadyDone(connection, edgeTable.format(area), schema_osm, skipGraphCheck) and
-            utils.isProcessAlreadyDone(connection, nodeTable.format(area), schema_osm, skipGraphCheck)):
-        
+    if not (
+        utils.isProcessAlreadyDone(
+            connection, edgeTable.format(area), schema_osm, skipGraphCheck
+        )
+        and utils.isProcessAlreadyDone(
+            connection, nodeTable.format(area), schema_osm, skipGraphCheck
+        )
+    ):
+
         osm.createGraphFromBbox(
-            connection = connection,
-            engine = engine,
-            bbox = bbox,
-            area = area,
-            schema = schema_osm
+            connection=connection,
+            engine=engine,
+            bbox=bbox,
+            area=area,
+            schema=schema_osm,
         )
-        
+
         end = time.time()
         print(f"OSM graph of {area}: {end - start} seconds")
-    
+
     else:
         print("OSM graph already downloaded")
-    
+
     end = time.time()
     print(f"Download everything for {area}: {end - start} seconds")
     print()
-    
+
     total += end - start
-    
 
-print(f"It took {total} seconds in total")
+
+print(f"It took {total} seconds in total")