Add attributes to the DCD outputs

DCD-141

Author: kjnam

deltacd/dcd.py

@@ -17,6 +17,7 @@
 import numpy as np
 import pandas as pd
 import xarray as xr
+from deltacd import __version__
 from deltacd.detaw import convert_to_absolute_path
 
 # Set up a logger
@@ -256,14 +257,21 @@ def set_dcd_node_global_attributes(
     ds_dcd_nodes: xarray.Dataset
         dataset containing DCD node data
     """
-    title = "DeltaCD outputs"
+    title = (
+        "Outputs at model nodes from Delta Channel Depletion (DCD) module of DeltaCD"
+    )
     leach_factor = model_params.get("leach_scale")
     water_surface_evaporation = model_params.get("is_adding_waterbody_evaporation")
+    created_at = pd.Timestamp.now().strftime("%Y-%m-%d %H:%M:%S")
+    history = (
+        f"{created_at} - generated by DeltaCD version {__version__}, DCD module"
+    )
     dcd_inputs = json.dumps(model_params)
     ds_dcd_nodes = ds_dcd_nodes.assign_attrs(
         title=title,
         leach_factor=leach_factor,
         water_surface_evaporation=str(water_surface_evaporation),
+        history=history,
         dcd_inputs=dcd_inputs,
     )
     return ds_dcd_nodes
@@ -349,21 +357,21 @@ def island_to_nodes(ds_dcd, input_data):
     # Diversion
     da_div_nodes = ds_dcd.diversion.dot(ds_dist_rates.divrate)
     da_div_nodes = da_div_nodes.assign_attrs(
-        unit="cfs", description="diversion flow at nodes"
+        units="cfs", description="diversion flow at model nodes"
     )
 
     # Seepage
     da_spg_nodes = ds_dcd.seepage.dot(ds_dist_rates.divrate)
     da_spg_nodes = da_spg_nodes.assign_attrs(
-        unit="cfs", description="seepage flow at nodes"
+        units="cfs", description="seepage flow at model nodes"
     )
 
     # Drainage
     da_drn_nodes = ds_dcd.drainage.dot(ds_dist_rates.drnrate) + ds_dcd.runoff.dot(
         ds_dist_rates.drnrate
     )
     da_drn_nodes = da_drn_nodes.assign_attrs(
-        unit="cfs", description="drainage flow at nodes"
+        units="cfs", description="drainage flow at model nodes"
     )
 
     # Create a xarray.Dataset.
@@ -373,6 +381,7 @@ def island_to_nodes(ds_dcd, input_data):
     ds_dcd_nodes = da_div_nodes.to_dataset(name="diversion")
     ds_dcd_nodes["seepage"] = da_spg_nodes
     ds_dcd_nodes["drainage"] = da_drn_nodes
+    ds_dcd_nodes.coords["node"].attrs["description"] = "model node name"
 
     return ds_dcd_nodes
 
@@ -673,27 +682,59 @@ def calculate_depletion(model_params: dict, input_data: dict) -> xr.Dataset:
     # FIXME Add attributes
     da_gwf *= taf2cfs
     ds_dcd = da_gwf.to_dataset(name="groundwater")
+    ds_dcd["groundwater"].attrs = {
+        "units": "cfs",
+        "description": "groundwater at subarea",
+    }
 
     ds_dcd["groundwater_to_applied_water"] = da_gw1 * taf2cfs
+    ds_dcd["groundwater_to_applied_water"].attrs = {
+        "units": "cfs",
+        "description": "groundwater flow to applied water",
+    }
 
     ds_dcd["applied_water"] = da_aw / da_eta * taf2cfs
+    ds_dcd["applied_water"].attrs = {
+        "units": "cfs",
+        "description": "applied water at subarea",
+    }
 
     da_runoff_after_percolation *= taf2cfs
     ds_dcd["runoff"] = da_runoff_after_percolation
+    ds_dcd["runoff"].attrs = {
+        "units": "cfs",
+        "description": "runoff at subarea",
+    }
 
     # Calculate deep percolation
     factor_deep_percolation = model_params.get("deep_percolation_rate")
     ds_deep_percolation = da_runoff * factor_deep_percolation
     ds_dcd["deep_percolation"] = ds_deep_percolation
+    ds_dcd["deep_percolation"].attrs = {
+        "units": "cfs",
+        "description": "deep percolation at subarea",
+    }
 
     da_diversion *= taf2cfs
     ds_dcd["diversion"] = da_diversion
+    ds_dcd["diversion"].attrs = {
+        "units": "cfs",
+        "description": "diversion flow at subarea",
+    }
 
     da_drainage *= taf2cfs
     ds_dcd["drainage"] = da_drainage
+    ds_dcd["drainage"].attrs = {
+        "units": "cfs",
+        "description": "drainage flow at subarea",
+    }
 
     da_seepage *= taf2cfs
     ds_dcd["seepage"] = da_seepage
+    ds_dcd["seepage"].attrs = {
+        "units": "cfs",
+        "description": "seepage flow at subarea",
+    }
 
     # Now we subtract the values from 'extension'
     ds_dcd_subtracted = ds_dcd.copy(deep=True)
@@ -705,6 +746,15 @@ def calculate_depletion(model_params: dict, input_data: dict) -> xr.Dataset:
                 area_id=area_id
             )
 
+    created_at = pd.Timestamp.now().strftime("%Y-%m-%d %H:%M:%S")
+
+    title = "Outputs at subareas from Delta Channel Depletion (DCD) module of DeltaCD"
+    ds_dcd_subtracted.attrs["title"] = title
+    history = (
+        f"{created_at} - generated by DeltaCD version {__version__}, DCD module"
+    )
+    ds_dcd_subtracted.attrs["history"] = history
+
     return ds_dcd_subtracted