py-ewr 2.3.8__tar.gz → 2.3.9__tar.gz

{py_ewr-2.3.8 → py_ewr-2.3.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py_ewr
-Version: 2.3.8
+Version: 2.3.9
 Summary: Environmental Water Requirement calculator
 Home-page: https://github.com/MDBAuth/EWR_tool
 Author: Martin Job
@@ -44,7 +44,7 @@ Dynamic: summary
 [![PyPI](https://img.shields.io/pypi/v/py-ewr)](https://pypi.org/project/py-ewr/)
 [![DOI](https://zenodo.org/badge/342122359.svg)](https://zenodo.org/badge/latestdoi/342122359)
 
-### **ewr tool version 2.3.8 README**
+### **ewr tool version 2.3.9 README**
 
 ### **Notes on recent version updates**
 
@@ -59,13 +59,13 @@ Dynamic: summary
 - Added new FIRM ID file mapping FIRM ID to gauge number.
 
 #### parameter metadata
-- Updated parameter sheet
+- Updated parameter sheet and objective mapping correcting some mismatched links between environmental objectives and EWRs
 - Fix SDL resource unit mapping in the parameter sheet
 - Adding lat and lon to the parameter sheet
 - Added in model handling for FIRM model outputs
 - Various minor variable renamings for consistency
 - Renamed MaxLevelRise to MaxLevelChange
-- Removed AnnualFlowSum column from parameter sheet
+- Removed AnnualFlowSum and MinLevelRise column from parameter sheet
 - New format of objective mapping includes the adding of objective mapping back into the parameter sheet and one secondary dataframe (objective_reference.csv) in parameter metadata.
 
 ### **Installation**

{py_ewr-2.3.8 → py_ewr-2.3.9}/README.md

@@ -3,7 +3,7 @@
 [![PyPI](https://img.shields.io/pypi/v/py-ewr)](https://pypi.org/project/py-ewr/)
 [![DOI](https://zenodo.org/badge/342122359.svg)](https://zenodo.org/badge/latestdoi/342122359)
 
-### **ewr tool version 2.3.8 README**
+### **ewr tool version 2.3.9 README**
 
 ### **Notes on recent version updates**
 
@@ -18,13 +18,13 @@
 - Added new FIRM ID file mapping FIRM ID to gauge number.
 
 #### parameter metadata
-- Updated parameter sheet
+- Updated parameter sheet and objective mapping correcting some mismatched links between environmental objectives and EWRs
 - Fix SDL resource unit mapping in the parameter sheet
 - Adding lat and lon to the parameter sheet
 - Added in model handling for FIRM model outputs
 - Various minor variable renamings for consistency
 - Renamed MaxLevelRise to MaxLevelChange
-- Removed AnnualFlowSum column from parameter sheet
+- Removed AnnualFlowSum and MinLevelRise column from parameter sheet
 - New format of objective mapping includes the adding of objective mapping back into the parameter sheet and one secondary dataframe (objective_reference.csv) in parameter metadata.
 
 ### **Installation**

{py_ewr-2.3.8 → py_ewr-2.3.9}/py_ewr/data_inputs.py

@@ -542,16 +542,43 @@ def gauge_groups(parameter_sheet: pd.DataFrame) -> dict:
 
 # def gauges_to_measurand()
 
-def get_causal_ewr() -> dict:
 
-    ewr2obj_path = os.path.join(BASE_PATH, "parameter_metadata/ewr2obj.csv")
-    obj2target_path = os.path.join(BASE_PATH, "parameter_metadata/obj2target.csv")
-    obj2yrtarget_path = os.path.join(BASE_PATH, "parameter_metadata/obj2yrtarget.csv")
+def get_obj_mapping(
+    parameter_sheet_path=None,
+    objective_reference_path=None
+) -> pd.DataFrame:
+    '''
+    Retrieves objective mapping and merges with parameter sheet on Gauge, Planning Unit, Code, and LTWPShortName
+    to create a longform table that lists the associations between each EWR and ecological objectives.
+    Returns a DataFrame with the merged result.
+    Args:
+        param_sheet_path (str) = file path to parameter sheet. If None, default parameter_sheet.csv inside the tool is selected
+        obj_ref_path (str) = file path to objective mapping csv. If Not, default objective_reference.csv inside EWR tool is selected
+    '''
+    param_sheet_cols = [
+        'PlanningUnitName', 'LTWPShortName',  'SWSDLName', 'State', 'Gauge', 'Code', 'EnvObj'
+    ]
 
-    causal_ewr = {
-        "ewr2obj": pd.read_csv(ewr2obj_path),
-        "obj2target": pd.read_csv(obj2target_path),
-        "obj2yrtarget":pd.read_csv(obj2yrtarget_path)
-    }
+    if not objective_reference_path:
+        objective_reference_path = os.path.join(BASE_PATH, "parameter_metadata/obj_reference.csv")
+    
 
-    return causal_ewr
+    obj_ref = pd.read_csv(objective_reference_path)
+    
+
+    okay_EWRs, _ = get_EWR_table(file_path=parameter_sheet_path)
+    okay_EWRs_sub = okay_EWRs[param_sheet_cols]
+    
+    # Split 'EnvObj' by '+' and explode to long format
+    longform_ewr = okay_EWRs_sub.assign(
+        EnvObj=okay_EWRs_sub['EnvObj'].str.split('+')
+    ).explode('EnvObj').drop_duplicates()
+
+    merged_df = longform_ewr.merge(
+        obj_ref,
+        left_on= ['LTWPShortName', 'PlanningUnitName', 'Gauge', 'Code', 'EnvObj', 'SWSDLName', 'State'],
+        right_on=['LTWPShortName', 'PlanningUnitName', 'Gauge', 'Code', 'EnvObj', 'SWSDLName', 'State'],
+        how='left'
+    )
+
+    return merged_df

{py_ewr-2.3.8 → py_ewr-2.3.9}/py_ewr/parameter_metadata/ewr_calc_config.json

@@ -66,6 +66,7 @@
         "OB-WS2_P-single-F",
         "OB-WS4_S-single-F",
         "OB-WS4_P-single-F",
+        "BK1-single-F",
         "BK1_S-single-F",
         "BK1_P-single-F",
         "OB-WL1_P-single-F",
@@ -151,6 +152,7 @@
         "F2b_P-single-F",
         "F2a_S-single-F",
         "F2b_S-single-F",
+        "BK1-single-F", 
         "BK2a_P-single-F",
         "BK2b_P-single-F",
         "BK2a_S-single-F",
@@ -171,6 +173,7 @@
         "F2d-single-F",
         "F3a-single-F",
         "F3b-single-F",
+        "OB1-single-F",
         "OB1a-single-F",
         "OB1b-single-F",
         "OB2a-single-F",
@@ -178,12 +181,14 @@
         "F1_a_P-single-F",
         "F1_a_S-single-F",
         "F1_b-single-F",
+        "F2-single-F",
         "F2_a_P_pd-single-F",
         "F2_a_P_sd-single-F",
         "F2_a_S_pd-single-F",
         "F2_a_S_sd-single-F",
         "F2_b_pd-single-F",
         "F2_b_sd-single-F",
+        "F3-single-F", 
         "F3_P_pd-single-F",
         "F3_P_sd-single-F",
         "F3_S_pd-single-F",
@@ -267,6 +272,7 @@
         "SF2_S_sd-single-F",
         "BK1_P_pd-single-F",
         "BK1_S_sd-single-F",
+        "BF1-single-F",
         "F1_c-single-F",
         "F2_a-single-F",
         "F2_c-single-F",
@@ -417,7 +423,58 @@
         "F1_d_sd-single-F",
         "F2_d-single-F",
         "BK1_S_pd-single-F",
-        "BK1_P_sd-single-F"
+        "BK1_P_sd-single-F",
+        "Wetland1-single-F",
+        "Wetland2-single-F",
+        "Wetland3-single-F",
+        "F4-single-F",
+        "F5-single-F",
+        "F6-single-F",
+        "F7-single-F",
+        "F8-single-F",
+        "OB-WL2_P-single-F",
+        "OB-WL2_S-single-F",
+        "F1_d-single-F",
+        "F_EarlySpring1-single-F",
+        "F_LateSpring2-single-F",
+        "F_LateSpring1-single-F",
+        "F_Autumn1-single-F",
+        "F_Autumn2-single-F",
+        "F_Autumn3-single-F",
+        "BMF5a-single-F",
+        "BMF5b-single-F",
+        "BMF6a-single-F",
+        "BMF6b-single-F",
+        "BMF6c-single-F",
+        "BMF7ai-single-F",
+        "BMF7aii-single-F",
+        "BMF7b-single-F",
+        "BMF7c-single-F",
+        "BMF7d-single-F",
+        "BMF7e-single-F",
+        "BMF8a-single-F",
+        "BMF8b-single-F",
+        "BMF10a-single-F",
+        "BMF10b-single-F",
+        "BMF12a-single-F",
+        "BMF12b-single-F",
+        "BMF13a-single-F",
+        "BMF13b-single-F",
+        "BMF13c-single-F",
+        "F_Winter-single-F",
+        "OB1-WS-single-F",
+        "OB2-WS-single-F",
+        "OB1-WL-single-F",
+        "OB2-WL-single-F",
+        "OB3-WL-single-F",
+        "OB3-WL-single-F",
+        "LF1_platypus-single-F",
+        "Wetland_proxy-single-F",
+        "OB3-WS-single-F",
+        "F_EarlySpring2-single-F"
+        
+        
+        
     ],
     "flow_handle_sa": [
         "IC1_P-single-F",
@@ -534,7 +591,11 @@
         "BF1_9-single-F",
         "BF1_10-single-F",
         "BF1_11-single-F",
-        "BF1_12-single-F"
+        "BF1_12-single-F",
+        "BF_SumAut_1-single-F",
+        "BF_SumAut_2-single-F",
+        "BF_AllYear-single-F"
+        
     ],
     "ctf_handle_multi": [
         "CF-multigauge-F"