added meta

arc/toolbox/tenement-tools-toolbox.NRT_Build_Graphs.pyt.xml

@@ -1,2 +1,2 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata xml:lang="en"><Esri><CreaDate>20220326</CreaDate><CreaTime>19223100</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce></Esri></metadata>
+<?xml version="1.0"?>
+<metadata xml:lang="en"><Esri><CreaDate>20220326</CreaDate><CreaTime>19223100</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20220522</ModDate><ModTime>20015700</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="NRT_Build_Graphs" displayname="NRT Build Graphs" toolboxalias="toolbox" xmlns=""><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><parameters><param name="in_nc" displayname="Input NetCDF path" type="Required" direction="Input" datatype="String" expression="in_nc"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Filepath to the NetCDF associated with the monitoring area selected.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="in_parameters" displayname="Parameters" type="Required" direction="Input" datatype="String" expression="in_parameters"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;A string of parameters for the study area, seperated by ";".&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param></parameters><summary>&lt;DIV STYLE="text-align:Left;"&gt;&lt;P&gt;&lt;SPAN&gt;Graphs selected monitoring area data using Google Graphs. This tool is only intended for use by the UI backend and not the user.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;</summary></tool><dataIdInfo><idCitation><resTitle>NRT Build Graphs</resTitle></idCitation><searchKeys><keyword>graph</keyword><keyword>nrt</keyword><keyword>near-real-time</keyword><keyword>visualisation</keyword><keyword>ui</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"></ScopeCd></mdHrLv><mdDateSt Sync="TRUE">20220522</mdDateSt></metadata>

arc/toolbox/tenement-tools-toolbox.NRT_Create_Project.pyt.xml

@@ -1,2 +1,2 @@
 <?xml version="1.0"?>
-<metadata xml:lang="en"><Esri><CreaDate>20211130</CreaDate><CreaTime>21132600</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20220420</ModDate><ModTime>18080000</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="NRT_Create_Project" displayname="NRT Create Project" toolboxalias="toolbox" xmlns=""><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><parameters><param name="out_folder" displayname="Output Project Folder" type="Required" direction="Input" datatype="Folder" expression="out_folder"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Set an output folder location to create the near real-time monitoring files into. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Note: this folder should be somewhere that will not be moved.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param></parameters><summary>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Near real-time monitoring requires a project folder and geodatabase to store persistent monitoring area polygons and data cubes. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;You can create one project to store as many monitoring areas anywhere in Australia, or you can break up tenements or sites into projects (e.g., Ophthalmia Dam project, Yandi project, etc.). This is up to user discretion. &lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</summary></tool><dataIdInfo><idCitation><resTitle>NRT Create Project</resTitle></idCitation><searchKeys><keyword>nrt</keyword><keyword>monitoring</keyword><keyword>geodatabase</keyword><keyword>create</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv><mdDateSt Sync="TRUE">20220420</mdDateSt></metadata>
+<metadata xml:lang="en"><Esri><CreaDate>20211130</CreaDate><CreaTime>21132600</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20220522</ModDate><ModTime>20290000</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="NRT_Create_Project" displayname="NRT Create Project" toolboxalias="toolbox" xmlns=""><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><parameters><param name="out_folder" displayname="Output Project Folder" type="Required" direction="Input" datatype="Folder" expression="out_folder"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Set an output folder location to create the near real-time monitoring files into. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Note: this folder should be somewhere that will not be moved.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param></parameters><summary>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Near real-time monitoring requires a project folder and geodatabase to store persistent monitoring area polygons and satellite data. Create a project to store as many monitoring areas required for any area in Australia, or create multiple seperate projects to store different areas in seperate storage areas.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</summary></tool><dataIdInfo><idCitation><resTitle>NRT Create Project</resTitle></idCitation><searchKeys><keyword>nrt</keyword><keyword>monitoring</keyword><keyword>geodatabase</keyword><keyword>create</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv><mdDateSt Sync="TRUE">20220522</mdDateSt></metadata>

arc/toolbox/tenement-tools-toolbox.pyt.xml

@@ -1,2 +1,2 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<metadata xml:lang="en"><Esri><CreaDate>20210531</CreaDate><CreaTime>18552400</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20220522</ModDate><ModTime>131613</ModTime></Esri><toolbox name="tenement-tools-toolbox" alias="toolbox"><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><toolsets/></toolbox><dataIdInfo><idCitation><resTitle>tenement-tools-toolbox</resTitle></idCitation></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Toolbox</formatName></distorFormat></distributor></distInfo></metadata>
+<metadata xml:lang="en"><Esri><CreaDate>20210531</CreaDate><CreaTime>18552400</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20220522</ModDate><ModTime>201059</ModTime></Esri><toolbox name="tenement-tools-toolbox" alias="toolbox"><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><toolsets/></toolbox><dataIdInfo><idCitation><resTitle>tenement-tools-toolbox</resTitle></idCitation></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Toolbox</formatName></distorFormat></distributor></distInfo></metadata>

modules/nrt.py

@@ -3174,12 +3174,19 @@ def run_all(self):
         """
 
 
-
-# meta
 def validate_monitoring_areas(in_feat):
     """
-    Does relevant checks for information for a
-    gdb feature class of one or more monitoring areas.
+    Does relevant checks for information for a gdb feature 
+    class containing one or more monitoring areas.
+    
+    Parameters
+    ----------
+    in_feat: list
+        A path to a geodatabase containing monitoring areas.
+
+    Returns
+    -------
+    ds : xarray Dataset
     """
 
     # set up flag
@@ -3515,7 +3522,7 @@ def safe_savgol(arr, window_length=3, polyorder=1, a=0):
     except:
         # return empty array
         return np.full_like(arr, np.nan)
-        
+
 
 def detect_change(ds, method='both', var='veg_idx', train_start=None, train_end=None, persistence=1.0):
     """
@@ -4116,11 +4123,15 @@ def build_alerts(arr_r1, arr_r2, arr_r3, ruleset='1 and 2 or 3', direction='Decl
     return arr_alerts
 
 
-# meta
 def create_zone_graph():
     """
-    Creares a static zone legend graph for
-    the footer area of the sent alert email.
+    Creates a static zone legend graph for the footer 
+    area of a sent email alert. This function is not 
+    dynamic.
+
+    Returns
+    -------
+    arr : array of alert mask values.
     """
 
     try: