Minor updates to documentation

Author: shreyasgm

README.md

@@ -100,5 +100,113 @@ Open `src/.config` file with a text editor of your choice. You will see several
   - `PROJECT_ROOT`: This should be the path to the root directory of your project. Modify it if the default does not match your directory structure.
   - `GLOCAL_DATA_PATH`: Update this to the location where your Glocal dataset is stored.
 
-### Need Help?
+
+# Raw data
+
+The raw data used in the project shoule be placed in the following directory structure:
+
+```
+.
+└── raw
+    ├── airports
+    │   ├── datahub
+    │   ├── nunn_and_puga
+    ├── country_codes
+    ├── metadata
+    │   └── 15_ADMProjects
+    ├── mining
+    ├── point_data
+    │   └── telecom_antennas
+    ├── ports
+    │   ├── wld
+    │   └── wpi
+    ├── rasters
+    │   ├── dmsp
+    │   ├── elevation
+    │   ├── emissions
+    │   ├── fao
+    │   ├── gdelt_v2
+    │   ├── ghsl
+    │   ├── gpcp
+    │   ├── ntl_dmsp_ext
+    │   ├── ntl_dvnl
+    │   ├── population
+    │   ├── precipitation
+    │   ├── roads
+    │   ├── ruggedness
+    │   ├── sentinel_2
+    │   ├── solar_potential
+    │   ├── telecom_mobile_coverage
+    │   ├── temperature
+    │   ├── viirs
+    │   └── wind_potential
+    ├── remote_sensed
+    │   ├── ACLED
+    │   ├── all_countries_with_eth
+    │   ├── all_FAO
+    │   ├── CRU
+    │   ├── cru_raster
+    │   ├── elevation
+    │   ├── GDELT_ethnic
+    │   ├── GPCC
+    │   ├── GPCC_raster
+    │   ├── gpcp
+    │   ├── Latinobarometro
+    │   ├── nightlights
+    │   ├── population
+    │   ├── SCAD
+    │   ├── SCPDSI
+    │   ├── SCPDSI_raster
+    │   └── temperature
+    ├── roads
+    │   ├── code
+    │   └── test
+    └── shapefiles
+        ├── gadm
+        ├── gadm_geoparquet
+        └── ghs
+```
+
+Further, the intermediate data folder should have the following structure - some of these folders are automatically created by the code, whereas others (such as the downloads from Google Cloud Storage) need to be created manually. In order to simplify the process, it is best to create all the folders manually.
+
+```
+├── intermediate
+│   ├── acled
+│   ├── gadm_without_geometry
+│   ├── gee_accessibility_agg
+│   ├── gee_forest_change
+│   ├── gee_landcover_agg
+│   ├── gee_landcover_compiled
+│   ├── gee_landcover_processed
+│   ├── gee_viirs_agg
+│   ├── gee_viirs_monthly
+│   ├── ghs
+│   ├── ghs_gadm
+│   ├── individual_aggregations
+│   ├── market_access
+│   ├── mining
+│   ├── overture
+│   ├── raster_aggregations
+│   │   ├── dmsp
+│   │   ├── elevation
+│   │   ├── emissions
+│   │   ├── fao
+│   │   ├── ntl_dmsp_ext
+│   │   ├── ntl_dvnl
+│   │   ├── population
+│   │   ├── precipitation
+│   │   ├── roads
+│   │   ├── ruggedness
+│   │   ├── solar_potential
+│   │   ├── telecom_mobile_coverage
+│   │   ├── temperature
+│   │   ├── viirs
+│   │   └── wind_potential
+│   ├── roads
+│   │   └── grip
+│   ├── viirs
+│   └── viirs_monthly
+```
+
+# Need Help?
 If you encounter any issues or have questions about configuring your environment, feel free to open an issue in the project repository or contact the project authors.

src/case_study/deforestation_colombia.ipynb

@@ -47,7 +47,8 @@
    "outputs": [],
    "source": [
     "# Set output folder path - default is the location of the script\n",
-    "OUTPUT_FOLDER = os.path.realpath(\".\")"
+    "OUTPUT_FOLDER = os.path.realpath(\".\")\n",
+    "print(OUTPUT_FOLDER)"
    ]
   },
   {

src/google_earth_engine/README.md

@@ -21,4 +21,8 @@ Make sure that earthengine-api is installed (should already be installed if you
 
 Then, run `earthengine authenticate` to authenticate your Google Earth Engine account.
 
-More details available [here](https://developers.google.com/earth-engine/guides/python_install-conda)
+More details available [here](https://developers.google.com/earth-engine/guides/python_install-conda)
+
+# Running the notebooks
+
+As they are currently set up, each of these scripts will run the aggregations and export them to a Google Cloud Storage bucket. In order to replicate this code, you will need to set up a separate GCS bucket, or export to Google Drive. These exports are then downloaded and processed in the `combine_gadm.ipynb` notebook. Note that storage in GCS is not free, but the costs are minimal for the amount of data we are exporting. As of 2024, we had to pay about $2.5 per month for storage.

src/raster_aggregations/README.md

@@ -8,3 +8,4 @@ This folder contains sub-folders to handle aggregation of specific type of local
 Supporting scripts:
 
 - `zonal_stats_raster.R`: the main component of the pipeline that contains a function that does the raster aggregation given a raster file.
+