Fix typos, unused imports, unused variables, indention on notebook scripts (#2519)

Author: rfontanarosa

notebooks/generate_offline_imagery1.ipynb

@@ -59,11 +59,11 @@
     {
       "cell_type": "code",
       "source": [
-        "COUNTRY_NAME=input('Name of country to export, exactly as it appears in FAO GAUL 2015: ')\n",
+        "COUNTRY_NAME = input('Name of country to export, exactly as it appears in FAO GAUL 2015: ')\n",
         "\n",
-        "DEST_BUCKET=input('Bucket ID where GeoTIFFs should be stored: ')\n",
+        "DEST_BUCKET = input('Bucket ID where GeoTIFFs should be stored: ')\n",
         "\n",
-        "CLOUD_PROJECT=input('Cloud project for Earth Engine execution: ')"
+        "CLOUD_PROJECT = input('Cloud project for Earth Engine execution: ')"
       ],
       "metadata": {
         "id": "iA2QLfo1_jzU"
@@ -126,7 +126,7 @@
         "# Visualization params:\n",
         "S2_VIS_PARAMS = {'bands': ['B4', 'B3', 'B2'], 'min': 0, 'max': 2000, 'gamma': 1.2}\n",
         "HILLSHADE_VIS_PARAMS = {'min': 0, 'max': 160}\n",
-        "# Ooacity ranges for low and high illumination regions.\n",
+        "# Opacity ranges for low and high illumination regions.\n",
         "LO_MIN = 0\n",
         "LO_MAX = 170\n",
         "HI_MIN = 210\n",
@@ -411,7 +411,7 @@
         "    dark_pixels = img.select('B8').lt(NIR_DRK_THRESH*SR_BAND_SCALE).multiply(not_water).rename('dark_pixels')\n",
         "\n",
         "    # Determine the direction to project cloud shadow from clouds (assumes UTM projection).\n",
-        "    shadow_azimuth = ee.Number(90).subtract(ee.Number(img.get('MEAN_SOLAR_AZIMUTH_ANGLE')));\n",
+        "    shadow_azimuth = ee.Number(90).subtract(ee.Number(img.get('MEAN_SOLAR_AZIMUTH_ANGLE')))\n",
         "\n",
         "    # Project shadows from clouds for the distance specified by the CLD_PRJ_DIST input.\n",
         "    cld_proj = (img.select('clouds').directionalDistanceTransform(shadow_azimuth, CLD_PRJ_DIST*10)\n",
@@ -470,7 +470,7 @@
         "  lo = ee.Image(1).subtract(lo_scaled).selfMask().visualize(**LO_VIS)\n",
         "\n",
         "  hi_clamped = hillshade.clamp(HI_MIN, HI_MAX)\n",
-        "  hi_scaled = hi_clamped.unitScale(HI_OPAC_MIN , HI_OPAC_MAX)\n",
+        "  hi_scaled = hi_clamped.unitScale(HI_OPAC_MIN, HI_OPAC_MAX)\n",
         "  hi = hi_scaled.selfMask().visualize(**HI_VIS)\n",
         "\n",
         "  return img.blend(lo.blend(hi))\n",
@@ -485,7 +485,7 @@
         "map.add_ee_image(image.clip(aoi), {}, 'Image export preview', show=True, opacity=1, min_zoom=9)\n",
         "map.fit_bounds([[aoi_bounds.south, aoi_bounds.west], [aoi_bounds.north, aoi_bounds.east]])\n",
         "\n",
-        "print(\"Visualizing preview - this may take awhile. You may proceed with other steps without waiting.\")\n",
+        "print(\"Visualizing preview - this may take a while. You may proceed with other steps without waiting.\")\n",
         "print()\n",
         "display(map)"
       ],
@@ -518,13 +518,13 @@
       "source": [
         "from unidecode import unidecode\n",
         "\n",
-        "def build_export_task(image, extent, max_zoom, file_name_prefix, dimensions):\n",
+        "def build_export_task(image, extent, file_name_prefix, dimensions):\n",
         "  x, y, z = extent\n",
         "  country = unidecode(COUNTRY_NAME).replace(\"'\", \"\").replace(\" \", \"-\")\n",
         "  return {\n",
         "    'fileFormat': 'GeoTIFF',\n",
         "    'image': image,\n",
-        "     # Note: Region is specified in the source image's CRS, not the target one.\n",
+        "    # Note: Region is specified in the source image's CRS, not the target one.\n",
         "    'region': tile_to_ee_bbox(extent),\n",
         "    'description': f\"Export-{country}-{z}-{x}-{y}\",\n",
         "    'bucket': DEST_BUCKET,\n",
@@ -540,7 +540,6 @@
         "tasks = [build_export_task(\n",
         "    image=image,\n",
         "    extent=extent,\n",
-        "    max_zoom=HI_RES_MAX_ZOOM,\n",
         "    file_name_prefix=f\"{DEST_PATH}/{extent.z}/{extent.x}/{extent.y}\",\n",
         "    dimensions=hi_res_dim)\n",
         " for extent in aoi_tileset_extents]\n",
@@ -576,7 +575,7 @@
         "\n",
         "# https://google-auth-oauthlib.readthedocs.io/en/latest/reference/google_auth_oauthlib.flow.html\n",
         "# Export missing tilesets.\n",
-        "print(\"Starting tasks. See running tasks at https://code.earthengine.google.com/tasks\")\n",
+        "print(f\"Starting tasks. See running tasks at https://code.earthengine.google.com/tasks?project={CLOUD_PROJECT}\")\n",
         "for i, t in enumerate(tasks):\n",
         "  name = t['fileNamePrefix'] + '.tif'\n",
         "  blob = storage.Blob(name, bucket)\n",

notebooks/generate_offline_imagery2.ipynb

@@ -33,11 +33,11 @@
         "\n",
         "This notebook converts normal GeoTIFFs into cloud optimized-GeoTIFFs (COGs) compatible with Google Maps Platform APIs and the Ground data collection platform Android app.\n",
         "\n",
-        "We've affectionally dubbed these Maps-optimized COGs as \"MOGs\" for convenience and brevity. See [README.md](https://github.com/google/ground-android/blob/master/ground/src/main/java/com/google/android/ground/ui/map/gms/mog/README.md) in Android implementation for details.\n",
+        "We've affectionately dubbed these Maps-optimized COGs as \"MOGs\" for convenience and brevity. See [README.md](https://github.com/google/ground-android/blob/master/ground/src/main/java/com/google/android/ground/ui/map/gms/mog/README.md) in Android implementation for details.\n",
         "\n",
         "Be sure [Generate Ground offline imagery](https://colab.research.google.com/github/google/ground-platform/blob/master/notebooks/generate_offline_imagery1.ipynb) has been run and Earth Engine tasks have completed before running this notebook.\n",
         "\n",
-        "By default, only new input images will be converted. GeoTIFF which already have a correspondign MOG will be skipped unless `OVERWRITE_EXISTING` is set `True`."
+        "By default, only new input images will be converted. GeoTIFFs which already have a corresponding MOG will be skipped unless `OVERWRITE_EXISTING` is set `True`."
       ],
       "metadata": {
         "id": "MN0yiT1u74PH"
@@ -64,9 +64,9 @@
     {
       "cell_type": "code",
       "source": [
-        "SRC_BUCKET_NAME=input('ID of bucket containing raw GeoTIFFs : ')\n",
+        "SRC_BUCKET_NAME=input('ID of bucket containing raw GeoTIFFs: ')\n",
         "\n",
-        "DEST_BUCKET_NAME=input('ID of bucket project where processed imagery is to be written: ')"
+        "DEST_BUCKET_NAME=input('ID of bucket where processed imagery is to be written: ')"
       ],
       "metadata": {
         "id": "wqIeqxMEI5-3"
@@ -79,7 +79,7 @@
       "source": [
         "### Custom paths\n",
         "\n",
-        "The can be adjusted as needed."
+        "These can be adjusted as needed."
       ],
       "metadata": {
         "id": "lTpntWE-JxHs"
@@ -88,8 +88,8 @@
     {
       "cell_type": "code",
       "source": [
-        "SRC_PATH=\"raw-imagery/s2/2022\"\n",
-        "DEST_PATH=\"offline-imagery/default\""
+        "SRC_PATH = \"raw-imagery/s2/2022\"\n",
+        "DEST_PATH = \"offline-imagery/default\""
       ],
       "metadata": {
         "id": "O4yVrj-6JrBM"
@@ -113,24 +113,23 @@
       "source": [
         "from math import pi\n",
         "\n",
-        "HI_RES_MOG_MIN_ZOOM=8\n",
-        "HI_RES_MOG_MAX_ZOOM=14\n",
-        "TILE_SIZE=256\n",
-        "NODATA_VALUE=0\n",
-        "OVERVIEW_FILENAME=\"overview.tif\"\n",
-        "OVERWRITE_EXISTING=False\n",
-        "\n",
-        "SRC_PREFIX=f\"{SRC_PATH}/{HI_RES_MOG_MIN_ZOOM}\"\n",
-        "OVERVIEW_TIFF_PATH=f\"{SRC_PREFIX}/{OVERVIEW_FILENAME}\"\n",
-        "DEST_PREFIX=f\"{DEST_PATH}/{HI_RES_MOG_MIN_ZOOM}\"\n",
-        "OVERVIEW_COG_PATH=f\"{DEST_PREFIX}/{OVERVIEW_FILENAME}\"\n",
-        "\n",
-        "# Constants\n",
-        "TMP_FILENAME=\"temp.tif\"\n",
-        "GCS_BROWSER_BASE_URL=\"https://console.cloud.google.com/storage/browser\"\n",
-        "GCS_DETAILS_BASE_URL=\"https://console.cloud.google.com/storage/browser/_details\"\n",
+        "HI_RES_MOG_MIN_ZOOM = 8\n",
+        "HI_RES_MOG_MAX_ZOOM = 14\n",
+        "TILE_SIZE = 256\n",
+        "NODATA_VALUE = 0\n",
+        "OVERVIEW_FILENAME = \"overview.tif\"\n",
+        "OVERWRITE_EXISTING = False\n",
+        "\n",
+        "SRC_PREFIX = f\"{SRC_PATH}/{HI_RES_MOG_MIN_ZOOM}\"\n",
+        "OVERVIEW_TIFF_PATH = f\"{SRC_PREFIX}/{OVERVIEW_FILENAME}\"\n",
+        "DEST_PREFIX = f\"{DEST_PATH}/{HI_RES_MOG_MIN_ZOOM}\"\n",
+        "OVERVIEW_COG_PATH = f\"{DEST_PREFIX}/{OVERVIEW_FILENAME}\"\n",
+        "\n",
+        "TMP_FILENAME = \"temp.tif\"\n",
+        "GCS_BROWSER_BASE_URL = \"https://console.cloud.google.com/storage/browser\"\n",
+        "GCS_DETAILS_BASE_URL = \"https://console.cloud.google.com/storage/browser/_details\"\n",
         "EPSG_3857_MAX = pi * 6378137\n",
-        "EPSG_3857_WORLD_BOUNDS=(-EPSG_3857_MAX, -EPSG_3857_MAX, EPSG_3857_MAX, EPSG_3857_MAX)"
+        "EPSG_3857_WORLD_BOUNDS = (-EPSG_3857_MAX, -EPSG_3857_MAX, EPSG_3857_MAX, EPSG_3857_MAX)"
       ],
       "metadata": {
         "id": "FFNaHNCUJpBE"
@@ -205,13 +204,11 @@
         "import rasterio\n",
         "from rasterio.transform import from_origin\n",
         "from rasterio.enums import Resampling\n",
-        "from rasterio.windows import from_bounds\n",
         "from osgeo import gdal # https://gdal.org/api/python/osgeo.gdal.html\n",
         "import os\n",
         "from rasterio.plot import show\n",
         "import matplotlib.pyplot as plt\n",
         "import numpy as np\n",
-        "import re\n",
         "import tempfile\n",
         "\n",
         "storage_client = storage.Client()\n",
@@ -246,7 +243,7 @@
       "cell_type": "code",
       "source": [
         "def show_size(path):\n",
-        "  file_stats=os.stat(path)\n",
+        "  file_stats = os.stat(path)\n",
         "  print(f'{path}: {file_stats.st_size / (1024 * 1024):.2f} MB')\n",
         "\n",
         "def show_thumbnail(src_path):\n",
@@ -261,10 +258,10 @@
         "  gdal.UseExceptions()\n",
         "\n",
         "  # Open the input raster\n",
-        "  src=gdal.Open(src_path)\n",
+        "  src = gdal.Open(src_path)\n",
         "\n",
-        "  # Open the output raster\n",
-        "  ds=gdal.Translate(\n",
+        "  # Create the output raster\n",
+        "  ds = gdal.Translate(\n",
         "      destName=TMP_FILENAME,\n",
         "      srcDS=src,\n",
         "      format=\"COG\",\n",
@@ -280,7 +277,7 @@
         "\n",
         "  # Close the output raster to flush buffer.\n",
         "  ds = None\n",
-        "  tmp_ds = None\n",
+        "  src = None\n",
         "\n",
         "  file_size = os.stat(TMP_FILENAME).st_size / (1024 * 1024)\n",
         "  print(f\"Uploading {file_size:.1f} MB to {dst_path}\")\n",
@@ -313,8 +310,8 @@
         "print(f\"Output: https://console.cloud.google.com/storage/browser/{DEST_BUCKET_NAME}/{DEST_PREFIX}\")\n",
         "\n",
         "for subpath in src_paths:\n",
-        "  src_path=f\"/vsigs_streaming/{SRC_BUCKET_NAME}/{subpath}\"\n",
-        "  dst_path=DEST_PREFIX + subpath[len(SRC_PREFIX):]\n",
+        "  src_path = f\"/vsigs_streaming/{SRC_BUCKET_NAME}/{subpath}\"\n",
+        "  dst_path = DEST_PREFIX + subpath[len(SRC_PREFIX):]\n",
         "  blob = storage.Blob(dst_path, dest_bucket)\n",
         "  if (not OVERWRITE_EXISTING and blob.exists(storage_client)):\n",
         "    print(f\"{dst_path} exists, skipping.\")\n",