Added documentation

wri · Aug 14, 2024 · 47b2712 · 47b2712
1 parent 05a0d7d
commit 47b2712
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 2 deletions.
diff --git a/tests/resources/README.md b/tests/resources/README.md
diff --git a/tests/resources/layer_dumps_for_br_lauro_de_freitas/README.md b/tests/resources/layer_dumps_for_br_lauro_de_freitas/README.md
@@ -0,0 +1,4 @@
+# QGIS manual analysis for Lauro de Freitas, Brazil
+Folder contains:
+1. Test code that can be set to output the layers as geotiff files. Execution is controlled by a "master switch"
+1. A QGIS file used for manually inspecting the generated geotiff files
diff --git a/tests/resources/layer_dumps_for_br_lauro_de_freitas/__init__.py b/tests/resources/layer_dumps_for_br_lauro_de_freitas/__init__.py
diff --git a/...ources/layers_for_br_lauro_de_freitas.qgs → ...reitas/layers_for_br_lauro_de_freitas.qgs b/...ources/layers_for_br_lauro_de_freitas.qgs → ...reitas/layers_for_br_lauro_de_freitas.qgs
diff --git a/...resources/test_write_layers_to_geotiff.py → ...e_freitas/test_write_layers_to_geotiff.py b/...resources/test_write_layers_to_geotiff.py → ...e_freitas/test_write_layers_to_geotiff.py
@@ -1,3 +1,5 @@
+# This code is mostly intended for manual execution
+
 import pytest
 import os
 import shutil
@@ -25,7 +27,11 @@
 from tests.resources.bbox_constants import BBOX_BR_LAURO_DE_FREITAS_1
 from tools.general_tools import create_temp_folder
 
+# RUN_DUMPS is the master control for whether the writes and tests are executed
+# Setting RUN_DUMPS to True turns on code execution.
+# Values should normally be set to False to avoid unnecessary execution.
 RUN_DUMPS = False
+# Both the tests and QGIS file are implemented for the same bounding box in Brazil.
 BBOX = BBOX_BR_LAURO_DE_FREITAS_1
 
 @pytest.mark.skipif(RUN_DUMPS == False, reason='Skipping since RUN_DUMPS set to False')