[FEATURE] Code With Us QaQc Dashboard Dec 2023

.gitignore

@@ -26,6 +26,7 @@
 *.tar
 *.zip
 !regional_areas.zip
+!qaqc_well_data.zip
 
 # Logs and databases #
 ######################

app/backend/aquifers/fixtures/aquifers.json

@@ -999,7 +999,13 @@
       "hydro_fracturing_yield_increase": null,
       "decommission_sealant_material": "CONCRETE",
       "decommission_backfill_material": "test",
-      "geom": "POINT(-125.376319 52.528545)"
+      "geom": "POINT(-125.376319 52.528545)",
+      "distance_to_pid": "123.45",
+      "geocode_distance": "543.21",
+      "score_address": "78.90",
+      "score_city": "56.78",
+      "cross_referenced": false,
+      "natural_resource_region": "Northeast"
     }
   },
   {
@@ -1124,7 +1130,13 @@
       "hydro_fracturing_yield_increase": null,
       "decommission_sealant_material": "CONCRETE",
       "decommission_backfill_material": "test",
-      "geom": "POINT(-125.351850 52.461419)"
+      "geom": "POINT(-125.351850 52.461419)",
+      "distance_to_pid": "234.56",
+      "geocode_distance": "654.32",
+      "score_address": "89.01",
+      "score_city": "67.89",
+      "cross_referenced": true,
+      "natural_resource_region": "Northeast"
     }
   },
   {
@@ -1249,7 +1261,13 @@
       "hydro_fracturing_yield_increase": null,
       "decommission_sealant_material": "CONCRETE",
       "decommission_backfill_material": "test",
-      "geom": "POINT(-125.361842 52.476454)"
+      "geom": "POINT(-125.361842 52.476454)",
+      "distance_to_pid": "345.67",
+      "geocode_distance": "765.43",
+      "score_address": "90.12",
+      "score_city": "78.90",
+      "cross_referenced": false,
+      "natural_resource_region": "Northeast"
     }
   },
   {
@@ -1373,7 +1391,13 @@
       "hydro_fracturing_yield_increase": null,
       "decommission_sealant_material": "CONCRETE",
       "decommission_backfill_material": "test",
-      "geom": "POINT(-125.381245 52.466459)"
+      "geom": "POINT(-125.381245 52.466459)",
+      "distance_to_pid": "456.78",
+      "geocode_distance": "876.54",
+      "score_address": "12.34",
+      "score_city": "89.01",
+      "cross_referenced": true,
+      "natural_resource_region": "Northeast"
     }
   },
   {

app/backend/gwells/fixtures/wellsearch.json

@@ -845,7 +845,15 @@
             "decommission_method": null,
             "decommission_details": null,
             "water_quality_characteristics": [],
-            "geom": "POINT(-122.540000 49.260000)"
+            "geom": "POINT(-122.540000 49.260000)",
+            "distance_to_pid": "123.45",
+            "geocode_distance": "543.21",
+            "score_address": "78.90",
+            "score_city": "56.78",
+            "cross_referenced": false,
+            "cross_referenced_date": "2023-02-08T17:06:47.229Z",
+            "cross_referenced_by": "DATA_LOAD_USER",
+            "natural_resource_region": "Northeast"
         }
     },
     {
@@ -966,7 +974,13 @@
             "drawdown": "190.00",
             "hydro_fracturing_performed": false,
             "hydro_fracturing_yield_increase": null,
-            "geom": "POINT(-122.540000 49.200000)"
+            "geom": "POINT(-122.540000 49.200000)",
+            "distance_to_pid": "234.56",
+            "geocode_distance": "654.32",
+            "score_address": "89.01",
+            "score_city": "67.89",
+            "cross_referenced": true,
+            "natural_resource_region": "Northeast"
         }
     },
     {
@@ -1087,7 +1101,13 @@
             "drawdown": null,
             "hydro_fracturing_performed": false,
             "hydro_fracturing_yield_increase": null,
-            "geom": "POINT(-122.580000 49.230000)"
+            "geom": "POINT(-122.580000 49.230000)",
+            "distance_to_pid": "345.67",
+            "geocode_distance": "765.43",
+            "score_address": "90.12",
+            "score_city": "78.90",
+            "cross_referenced": false,
+            "natural_resource_region": "Northeast"
         }
     },
     {
@@ -1208,7 +1228,13 @@
             "drawdown": null,
             "hydro_fracturing_performed": false,
             "hydro_fracturing_yield_increase": null,
-            "geom": "POINT(-122.590000 49.250000)"
+            "geom": "POINT(-122.590000 49.250000)",
+            "distance_to_pid": "456.78",
+            "geocode_distance": "876.54",
+            "score_address": "12.34",
+            "score_city": "89.01",
+            "cross_referenced": true,
+            "natural_resource_region": "Northeast"
         }
     },
     {
@@ -1332,7 +1358,13 @@
             "hydro_fracturing_yield_increase": null,
             "decommission_sealant_material": "CONCRETE",
             "decommission_backfill_material": "test",
-            "geom": "POINT(-125.360830 52.456449)"
+            "geom": "POINT(-125.360830 52.456449)",
+            "distance_to_pid": "567.89",
+            "geocode_distance": "987.65",
+            "score_address": "23.45",
+            "score_city": "90.12",
+            "cross_referenced": false,
+            "natural_resource_region": "South Coast"
         }
     },
     {
@@ -1479,7 +1511,13 @@
             ],
             "decommission_backfill_material": null,
             "decommission_sealant_material": null,
-            "geom": null
+            "geom": null,
+            "distance_to_pid": "678.90",
+            "geocode_distance": "109.87",
+            "score_address": "34.56",
+            "score_city": "12.34",
+            "cross_referenced": true,
+            "natural_resource_region": "Kootenay"
         }
     },
     {

app/backend/gwells/settings/__init__.py

@@ -12,6 +12,7 @@
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 import os
+import sys
 import datetime
 import logging.config
 from pathlib import Path
@@ -23,6 +24,7 @@
 
 BASE_DIR = str(Path(__file__).parents[2])
 
+TESTING = len(sys.argv) > 1 and sys.argv[1] == 'test'
 
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/

app/backend/gwells/utils.py

@@ -20,59 +20,48 @@ def isPointInsideBC(latitude, longitude):
     return False
 
 
-def geocode_bc_location(options={}):
-    """
-    Makes an HTTP call to the BC Physical Address Geocoder API
-    (https://www2.gov.bc.ca/gov/content/data/geographic-data-services/location-services/geocoder)
-    using any options provided as query string parameters. (the 'options'
-    parameter supports any query string parameter supported by the "addresses.json" 
-    endpoint.
-    If the address is successfully geocoded then this method returns a 
-    django.contrib.gis.geos.Point object corresponding to the first result.  
-    If a HTTP error occurs during 
-    communication with the remote API then an HTTPError exception is 
-    raised.  If the API call succeeds but does not find a coordinate 
-    matching the given address_string, then a ValueError is raised.
-    :param options: typical options are:
-      {
-        "addressString": "101 main st.",
-        "localityName": "Kelowna"
-      }
-    """
+def setup_parameters(options):
     default_options = {
-      "provinceCode": "BC",
-      "outputSRS": 4326,
-      "maxResults": 1,
-      "minScore": 65
+        "provinceCode": "BC",
+        "outputSRS": 4326,
+        "maxResults": 1,
+        "minScore": 65
     }
-    params = {}
-    params.update(default_options)
-    params.update(options)
+    return {**default_options, **options}
 
-    url = "https://geocoder.api.gov.bc.ca/addresses.json"
-
+def perform_api_request(url, params):
     try:
         resp = requests.get(url, params=params, timeout=10)
         resp.raise_for_status()
-    except HTTPError as e:
-        #caught and re-raised to be clear ane explicit which exceptions 
-        #this method may cause
+        return resp
+    except requests.HTTPError as e:
         raise e
 
-    features = []
-
-    try: 
-        features = resp.json().get('features')
-    except AttributeError as e:
+def process_response(response):
+    try:
+        features = response.json().get('features')
+        if not features:
+            raise ValueError("Unable to geocode address")
+        return features[0]
+    except AttributeError:
         raise ValueError("Unable to geocode address")
 
-    if not len(features):
-        raise ValueError("Unable to geocode address")
-
-    first_feature = features[0]
+def geocode_bc_location(options={}):
+    """
+    Performs an HTTP request to the BC Physical Address Geocoder API, 
+    returning a django.contrib.gis.geos.Point for the first result. Supports query 
+    string parameters via the 'options' argument. Raises HTTPError for 
+    communication issues and ValueError if no matching coordinate is found.
+    Example 'options': {"addressString": "101 main st.", "localityName": "Kelowna"}.
+    """
+    params = setup_parameters(options)
+    url = "https://geocoder.api.gov.bc.ca/addresses.json"
+    response = perform_api_request(url, params)
+    first_feature = process_response(response)
+
     try:
         point = GEOSGeometry(json.dumps(first_feature.get("geometry", {})))
-    except TypeError as e:
+    except TypeError:
         raise ValueError("Unable to geocode address")
 
     return point

app/backend/requirements.txt

@@ -28,3 +28,6 @@ geojson==2.4.1
 MarkupSafe>=2.0.1
 djangorestframework-simplejwt==4.4.0
 pyjwt>=2.0,<=2.4.0
+thefuzz==0.19.0
+geopandas==0.9.0
+pyproj==3.0.1

app/backend/wells/apps.py

@@ -33,3 +33,5 @@ class WellsConfig(AppConfig):
 
     def ready(self):
         post_migrate.connect(post_migration_callback, sender=self)
+        import wells.signals #noqa
+        import wells.utils #noqa

app/backend/wells/constants.py

@@ -28,3 +28,36 @@
 WELL_TAGS = []
 WELL_TAGS.extend(WELL_TAGS_PUBLIC.copy())
 WELL_TAGS.extend(WELL_TAGS_PRIVATE.copy())
+
+# bc geocoder endpoint of interest
+GEOCODER_ENDPOINT = "https://geocoder.api.gov.bc.ca/sites/nearest.json"
+ADDRESS_COLUMNS = [
+    "fullAddress",
+    "siteName",
+    "unitDesignator",
+    "unitNumber",
+    "unitNumberSuffix",
+    "civicNumber",
+    "civicNumberSuffix",
+    "streetName",
+    "streetType",
+    "isStreetTypePrefix",
+    "streetDirection",
+    "isStreetDirectionPrefix",
+    "streetQualifier",
+    "localityName",
+    "localityType",
+    "electoralArea",
+    "provinceCode",
+    "locationPositionalAccuracy",
+    "locationDescriptor",
+    "siteID",
+    "blockID",
+    "fullSiteDescriptor",
+    "accessNotes",
+    "siteStatus",
+    "siteRetireDate",
+    "changeDate",
+    "isOfficial",
+    "distance",
+]