From ba7b310c024f31f654d64d13f95ae009b33015bc Mon Sep 17 00:00:00 2001
From: Clemence Herny <clemence.herny@gmail.com>
Date: Wed, 24 Jan 2024 09:24:03 +0000
Subject: [PATCH] change <> path/folder in lower cases

---
 README.md              |  4 ++--
 config/config_det.yaml |  4 ++--
 scripts/README.md      | 26 +++++++++++++-------------
 3 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index cf5ec56..97b952b 100644
--- a/README.md
+++ b/README.md
@@ -236,7 +236,7 @@ $ stdl-objdet assess_detections config/config_trne.yaml
 
 ```bash
 $ mkdir -p input/input_det/logs
-$ cp output/output_trne/logs/<SELECTED MODEL PTH> input/input_det/logs
+$ cp output/output_trne/logs/<selected_model_pth> input/input_det/logs
 $ python scripts/prepare_data.py config/config_det.yaml
 ```
 
@@ -266,7 +266,7 @@ Copy the detections files `oth_detections_at_0dot3_threshold_year-{year}_{filter
 
 ```bash
 $ mkdir input/input_track
-$ cp output/output_det/<OTH_FILTERED_DETECTIONS_PATH> input/input_track
+$ cp output/output_det/<oth_filtered_detections_path> input/input_track
 $ python scripts/track_detections.py config/config_track.yaml
 $ python scripts/plots.py config/config_track.yaml
 ```
diff --git a/config/config_det.yaml b/config/config_det.yaml
index 9cd8c75..64403ef 100644
--- a/config/config_det.yaml
+++ b/config/config_det.yaml
@@ -6,7 +6,7 @@
 prepare_data.py: 
   srs: "EPSG:2056"  # Projection of the input file
   datasets:
-    shapefile: ./input/input_det/AoI/<AoI_SHAPEFILE>
+    shapefile: ./input/input_det/AoI/<AoI_shapefile>
   output_folder: ./output/output_det
   zoom_level: 16  # z, keep between 15 and 18  
 
@@ -57,7 +57,7 @@ make_detections.py:
 filter_detections.py:
   year: <YEAR>
   detections: ./output/output_det/oth_detections_at_0dot3_threshold.gpkg
-  shapefile: ./input/input_det/AoI/<AoI_SHAPEFILE>
+  shapefile: ./input/input_det/AoI/<AoI_shapefile>
   dem: ./input/input_det/DEM/switzerland_dem_EPSG2056.tif
   elevation: 1200.0 # m, altitude threshold
   score: 0.95 # detection score (from 0 to 1) provided by detectron2
diff --git a/scripts/README.md b/scripts/README.md
index edd01df..6adf9d9 100644
--- a/scripts/README.md
+++ b/scripts/README.md
@@ -21,8 +21,8 @@ It works along the config files `config_trne.yaml` and `config_det.yaml`. Input
 prepare_data.py:
     srs: <crs> 
     datasets:
-        shapefile: ./input/<SHAPEFILE>
-    output_folder: ./output/<DIR>
+        shapefile: ./input/<shapefile>
+    output_folder: ./output/<output_dir>
     zoom_level: <z>
 ```
 
@@ -30,11 +30,11 @@ The **srs** key provides the geographic framework to ensure that all the input d
 
 The labels (ground truth) polygons are used for the **Training and evaluation** workflow: 
 
-    <SHAPEFILE> = tlm-hr-trn-topo.shp
+    <shapefile> = tlm-hr-trn-topo.shp
     
 A region of Switzerland polygon is used for the **Detection** workflow:
 
-    <SHAPEFILE> = swissimage_footprint_<YEAR>.shp
+    <shapefile> = swissimage_footprint_<YEAR>.shp
 
 The outputs are `tiles.geojson` corresponding to shapefiles of the tiles obtained for the given AoI and `labels.geojson` corresponding to shapefiles of the input labels. 
 
@@ -67,12 +67,12 @@ Input and output paths of the config file must be adapted if necessary. The scri
 filter_detections.py:
     year: <YEAR> 
     input: ./output/output_det/oth_detections_at_<SCORE_LOWER_THRESHOLD_0dot*>_threshold.gpkg
-    shapefile: ./input/input_det/<SHAPEFILE> 
-    dem: ./input/input_det/<DEM_RASTER>  
-    elevation: <THRESHOLD VALUE>   
-    score: <THRESHOLD VALUE>
-    distance: <THRESHOLD VALUE> 
-    area: <THRESHOLD VALUE> 
+    shapefile: ./input/input_det/<shapefile> 
+    dem: ./input/input_det/<DEM_raster>  
+    elevation: <THRESHOLD_VALUE>   
+    score: <THRESHOLD_VALUE>
+    distance: <THRESHOLD_VALUE> 
+    area: <THRESHOLD_VALUE> 
     output: ./output/output_det/oth_detections_at_0dot*_threshold_year-{year}_score-{score}_area-{area}_elevation-{elevation}_distance-{distance}.geojson
 ```
 
@@ -98,7 +98,7 @@ filter_detections.py:
 The script can be run by executing the following command:
 
 ```bash
-$ python <DIR_PATH>/scripts/filter_detections.py <DIR_PATH>/config/config_det.yaml
+$ python <dir_path>/scripts/filter_detections.py <dir_path>/config/config_det.yaml
 ```
 
 ## Track detections
@@ -128,7 +128,7 @@ Input and output paths of the config file must be adapted if necessary. The scri
 The script can be run by executing the following command:
 
 ```bash
-$ python  <DIR_PATH>/scripts/track_detections.py <DIR_PATH>/config/config_track.yaml
+$ python  <dir_path>/scripts/track_detections.py <dir_path/config/config_track.yaml
 ```
 
 The outputs are a _geojson_ and _csv_ (**detections_years**) files saving the detections over the years with their characteristics (ID_object, ID_feature, year, score, area, geometry). 
@@ -152,7 +152,7 @@ Input or output paths must be adapted if necessary. The script takes as input a
 The script can be run by executing the following command:
 
 ```bash
-$ python <DIR_PATH>/scripts/filter_detections.py <DIR_PATH>/config/config_track.yaml
+$ python <dir_path>/scripts/filter_detections.py <dir_path>/config/config_track.yaml
 ```
 
 <p align="center">