py-ewr 2.3.0__tar.gz → 2.3.2__tar.gz

{py_ewr-2.3.0 → py_ewr-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py_ewr
-Version: 2.3.0
+Version: 2.3.2
 Summary: Environmental Water Requirement calculator
 Home-page: https://github.com/MDBAuth/EWR_tool
 Author: Martin Job
@@ -34,9 +34,10 @@ Requires-Dist: numpy<2
 [![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.0 README**
+### **EWR tool version 2.3.2 README**
 
 ### **Notes on recent version updates**
+- CLLMM_c and CLLMM_d ewrs are now able to be calculated without all barrage level gauges being present in the model file. 
 - Including draft objective mapping files in the package (see below sub heading **Objective mapping** for more information). Objective mapping has been therefore pulled out of the parameter sheet
 - Including an example parallel processing script for running the EWR tool
 - Adding handling for cases where there are single MDBA bigmod site IDs mapping to multiple different gauges
@@ -48,6 +49,7 @@ Requires-Dist: numpy<2
 - Standard time-series handling added - each column needs a gauge, followed by and underscore, followed by either flow or level (e.g. 409025_flow). This handling also has missing date filling - so any missing dates will be filled with NaN values in all columns.
 - bug fixes: spells of length equal to the minimum required spell length were getting filtered out of the successful events table and successful interevents table, fixed misclassification of some gauges to flow, level, and lake level categories
 - New EWRs: New Qld EWRs - SF_FD and BF_FD used to look into the FD EWRs in closer detail.
+- Adding state and Surface Water SDL (SWSDL) to py-ewr output tables
 
 ### **Installation**
 

{py_ewr-2.3.0 → py_ewr-2.3.2}/README.md

@@ -3,9 +3,10 @@
 [![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.0 README**
+### **EWR tool version 2.3.2 README**
 
 ### **Notes on recent version updates**
+- CLLMM_c and CLLMM_d ewrs are now able to be calculated without all barrage level gauges being present in the model file. 
 - Including draft objective mapping files in the package (see below sub heading **Objective mapping** for more information). Objective mapping has been therefore pulled out of the parameter sheet
 - Including an example parallel processing script for running the EWR tool
 - Adding handling for cases where there are single MDBA bigmod site IDs mapping to multiple different gauges
@@ -17,6 +18,7 @@
 - Standard time-series handling added - each column needs a gauge, followed by and underscore, followed by either flow or level (e.g. 409025_flow). This handling also has missing date filling - so any missing dates will be filled with NaN values in all columns.
 - bug fixes: spells of length equal to the minimum required spell length were getting filtered out of the successful events table and successful interevents table, fixed misclassification of some gauges to flow, level, and lake level categories
 - New EWRs: New Qld EWRs - SF_FD and BF_FD used to look into the FD EWRs in closer detail.
+- Adding state and Surface Water SDL (SWSDL) to py-ewr output tables
 
 ### **Installation**
 

{py_ewr-2.3.0 → py_ewr-2.3.2}/py_ewr/data_inputs.py

@@ -50,7 +50,7 @@ def get_EWR_table(file_path:str = None) -> dict:
     
     if file_path:
         df = pd.read_csv(file_path,
-         usecols=['PlanningUnitID', 'PlanningUnitName',  'LTWPShortName', 'CompliancePoint/Node', 'Gauge', 'Code', 'StartMonth',
+         usecols=['PlanningUnitID', 'PlanningUnitName',  'LTWPShortName', 'SWSDLName', 'State', 'CompliancePoint/Node', 'Gauge', 'Code', 'StartMonth',
                               'EndMonth', 'TargetFrequency', 'TargetFrequencyMin', 'TargetFrequencyMax', 'EventsPerYear', 'Duration', 'MinSpell', 
                               'FlowThresholdMin', 'FlowThresholdMax', 'MaxInter-event', 'WithinEventGapTolerance', 'WeirpoolGauge', 'FlowLevelVolume', 
                               'LevelThresholdMin', 'LevelThresholdMax', 'VolumeThreshold', 'DrawdownRate', 'MaxLevelRise','AccumulationPeriod',
@@ -66,7 +66,7 @@ def get_EWR_table(file_path:str = None) -> dict:
         my_url = os.path.join(BASE_PATH, "parameter_metadata/parameter_sheet.csv")
         proxies={} # Populate with your proxy settings
         df = pd.read_csv(my_url,
-            usecols=['PlanningUnitID', 'PlanningUnitName',  'LTWPShortName', 'CompliancePoint/Node', 'Gauge', 'Code', 'StartMonth',
+            usecols=['PlanningUnitID', 'PlanningUnitName',  'LTWPShortName', 'SWSDLName', 'State', 'CompliancePoint/Node', 'Gauge', 'Code', 'StartMonth',
                               'EndMonth', 'TargetFrequency', 'TargetFrequencyMin', 'TargetFrequencyMax', 'EventsPerYear', 'Duration', 'MinSpell', 
                               'FlowThresholdMin', 'FlowThresholdMax', 'MaxInter-event', 'WithinEventGapTolerance', 'WeirpoolGauge', 'FlowLevelVolume', 
                               'LevelThresholdMin', 'LevelThresholdMax', 'VolumeThreshold', 'DrawdownRate', 'MaxLevelRise', 'AccumulationPeriod',

{py_ewr-2.3.0 → py_ewr-2.3.2}/py_ewr/evaluate_EWRs.py

@@ -1148,33 +1148,37 @@ def barrage_level_handle(PU: str, gauge: str, EWR: str, EWR_table: pd.DataFrame,
     Returns:
         tuple[pd.DataFrame, tuple[dict]]: EWR results for the current planning unit iteration (updated); dictionary of EWR event information
     """
+    print(df_L.head())
     barrage_level_gauges = data_inputs.get_barrage_level_gauges()
     all_required_gauges = barrage_level_gauges.get(gauge)
+    # if all_required_gauges:
+    #     all_required_gauges_in_df_L = all(gauge in df_L.columns for gauge in all_required_gauges)
     if all_required_gauges:
-        all_required_gauges_in_df_L = all(gauge in df_L.columns for gauge in all_required_gauges)
-    # check if current gauge is the main barrage gauge
-        if all_required_gauges_in_df_L:
-            pull = data_inputs.get_EWR_components('barrage-level')
-            EWR_info = get_EWRs(PU, gauge, EWR, EWR_table, pull)
-            masked_dates = mask_dates(EWR_info, df_L)
-            # Extract a daily timeseries for water years:
-            water_years = wateryear_daily(df_L, EWR_info)
-            # If there is no level data loaded in, let user know and skip the analysis
-            df = df_L.copy(deep=True)
-            # calculate 5 day moving average and average of all required gauges
-            df_5_day_averages = calculate_n_day_moving_average(df,5)
-            df_5_day_averages['mean'] = df[all_required_gauges].mean(axis=1)
-            cllmm_type = what_cllmm_type(EWR_info)
-            if cllmm_type == 'c':
-                E, D = lower_lakes_level_calc(EWR_info, df_5_day_averages['mean'], water_years, df_L.index, masked_dates)
-            if cllmm_type == 'd':
-                E, D = coorong_level_calc(EWR_info, df_5_day_averages['mean'], water_years, df_L.index, masked_dates)
+        all_required_gauges_in_df_L = [gauge for gauge in all_required_gauges if gauge in df_L.columns] 
+        #NOTE as all_required_gauges_in_df_L is boolean, the indexing is stil including all gauges in all_required_gauges.
+        # directly subset and use all_required_gauges_in_df_L as the new list. 
+    if all_required_gauges_in_df_L:
+        pull = data_inputs.get_EWR_components('barrage-level')
+        EWR_info = get_EWRs(PU, gauge, EWR, EWR_table, pull)
+        masked_dates = mask_dates(EWR_info, df_L)
+        # Extract a daily timeseries for water years:
+        water_years = wateryear_daily(df_L, EWR_info)
+        # If there is no level data loaded in, let user know and skip the analysis
+        df = df_L.copy(deep=True)
+        # calculate 5 day moving average and average of all required gauges
+        df_5_day_averages = calculate_n_day_moving_average(df,5)
+        df_5_day_averages['mean'] = df[all_required_gauges_in_df_L].mean(axis=1)
+        cllmm_type = what_cllmm_type(EWR_info)
+        if cllmm_type == 'c':
+            E, D = lower_lakes_level_calc(EWR_info, df_5_day_averages['mean'], water_years, df_L.index, masked_dates)
+        if cllmm_type == 'd':
+            E, D = coorong_level_calc(EWR_info, df_5_day_averages['mean'], water_years, df_L.index, masked_dates)
         
         PU_df = event_stats(df_L, PU_df, gauge, EWR, EWR_info, E, D, water_years)    
         return PU_df, tuple([E])
 
     else:
-        print(f'skipping calculation because gauge {" ".join(all_required_gauges)} is not the main barrage level gauge ')
+        print(f'skipping calculation because gauge {" ".join(all_required_gauges)} is not the main barrage level gauge ') #TODO: improve error message
         return PU_df, None
 
 def rise_and_fall_handle(PU: str, gauge: str, EWR: str, EWR_table: pd.DataFrame, df_F: pd.DataFrame, df_L: pd.DataFrame, PU_df: pd.DataFrame) -> tuple:

{py_ewr-2.3.0 → py_ewr-2.3.2}/py_ewr/model_metadata/SiteID_MDBA.csv

@@ -1347,6 +1347,7 @@ LOCK7US,River Murray U/S Lock 7,,426508,5
 LOCK7US,River Murray U/S Lock 7,,A4260508,5
 LOCK8DS,River Murray D/S Lock 8,,4260507,5
 LOCK8US,River Murray U/S Lock 8,,426506,5
+LOCK8US,River Murray U/S Lock 8,,A426506,5
 LOCK9DS,River Murray D/S Lock 9,,4260505,5
 LOCK 9 ,River Murray U/S Lock 9,SAMPLE AT GAUGING STATION,A4260501,5
 LOCK9US,River Murray U/S Lock 9,SAMPLE AT GAUGING STATION,A4260501,5
@@ -2689,6 +2690,7 @@ FLOWSA ,A4261001,Flow at South Australia border,A4261001,5
 BARRAGE,A4261002,Barrages near the Murray Mouth,A4261002,5
 Bills Pipe,Bills Pipe,North Redbank,Bills Pipe,2
 "Eulimbah, Nimmie Creek","Eulimbah, Nimmie Creek","Gayini/ Nimmie-Caira, combined Eulimbah and Nimmie Creek regulators","Eulimbah, Nimmie Creek",2
+Eulimbah_Nimmie Creek,"Eulimbah, Nimmie Creek","Gayini/ Nimmie-Caira, combined Eulimbah and Nimmie Creek regulators","Eulimbah, Nimmie Creek",2
 Glen Dee,Glen Dee,"Western Lakes, Glenn Dee",Glen Dee,2
 Pattos Pipe,Pattos Pipe,North Redbank,Pattos Pipe,2
 Pump direct from river,Pump direct from river,"North Redbank, pumped direct from river",Pump direct from river,2
@@ -2698,3 +2700,4 @@ Pumped from Yanga Lake,Pumped from Yanga Lake,Yanga (South  Redbank),Pumped from
 410700,Cotter River at Kiosk,ACT - Icon Water Limited,410700,3
 410747,Cotter River below Bendora Dam,ACT - Icon Water Limited,410747,3
 410752,Cotter River below Corin Dam,ACT - Icon Water Limited,410752,3
+8MAREBON,Marebone Break @ d/s Marebone Regulator,Marebone Break @ d/s Marebone Regulator,421088,2

{py_ewr-2.3.0 → py_ewr-2.3.2}/py_ewr/observed_handling.py

@@ -226,10 +226,10 @@ class ObservedHandler:
         events_to_process = summarise_results.get_events_to_process(self.yearly_events)
         all_events = summarise_results.process_all_events_results(events_to_process)
 
-        all_events = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge'],
+        all_events = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge', 'State', 'SWSDLName'],
                                 left_table=all_events,
                                 left_on=['gauge','pu','ewr'],
-                                selected_columns= ['scenario', 'gauge', 'pu', 'ewr', 'waterYear', 'startDate', 'endDate',
+                                selected_columns= ['scenario', 'gauge', 'pu', 'State', 'SWSDLName', 'ewr', 'waterYear', 'startDate', 'endDate',
                                         'eventDuration', 'eventLength', 
                                         'Multigauge'],
                                 parameter_sheet_path=self.parameter_sheet)
@@ -246,10 +246,10 @@ class ObservedHandler:
         events_to_process = summarise_results.get_events_to_process(self.yearly_events)
         all_events_temp = summarise_results.process_all_events_results(events_to_process)
 
-        all_events_temp = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge'],
+        all_events_temp = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge', 'State', 'SWSDLName'],
                         left_table=all_events_temp,
                         left_on=['gauge','pu','ewr'],
-                        selected_columns= ['scenario', 'gauge', 'pu', 'ewr', 'waterYear', 'startDate', 'endDate',
+                        selected_columns= ['scenario', 'gauge', 'pu', 'State', 'SWSDLName', 'ewr', 'waterYear', 'startDate', 'endDate',
                                 'eventDuration', 'eventLength', 
                                 'Multigauge'],
                         parameter_sheet_path=self.parameter_sheet)
@@ -274,10 +274,10 @@ class ObservedHandler:
         events_to_process = summarise_results.get_events_to_process(self.yearly_events)
         all_events_temp1 = summarise_results.process_all_events_results(events_to_process)
 
-        all_events_temp1 = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge'],
+        all_events_temp1 = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge', 'State', 'SWSDLName'],
                         left_table=all_events_temp1,
                         left_on=['gauge','pu','ewr'],
-                        selected_columns= ['scenario', 'gauge', 'pu', 'ewr', 'waterYear', 'startDate', 'endDate',
+                        selected_columns= ['scenario', 'gauge', 'pu', 'State', 'SWSDLName', 'ewr', 'waterYear', 'startDate', 'endDate',
                                 'eventDuration', 'eventLength', 
                                 'Multigauge'],
                         parameter_sheet_path=self.parameter_sheet)
@@ -296,10 +296,10 @@ class ObservedHandler:
         events_to_process = summarise_results.get_events_to_process(self.yearly_events)
         all_events_temp2 = summarise_results.process_all_events_results(events_to_process)
 
-        all_events_temp2 = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge'],
+        all_events_temp2 = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge', 'State', 'SWSDLName'],
                         left_table=all_events_temp2,
                         left_on=['gauge','pu','ewr'],
-                        selected_columns= ['scenario', 'gauge', 'pu', 'ewr', 'waterYear', 'startDate', 'endDate',
+                        selected_columns= ['scenario', 'gauge', 'pu', 'State', 'SWSDLName', 'ewr', 'waterYear', 'startDate', 'endDate',
                                 'eventDuration', 'eventLength', 
                                 'Multigauge'],
                         parameter_sheet_path=self.parameter_sheet)
@@ -329,24 +329,24 @@ class ObservedHandler:
         to_process = summarise_results.pu_dfs_to_process(self.pu_ewr_statistics)
         yearly_ewr_results = summarise_results.process_df_results(to_process)
 
-        yearly_ewr_results = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge'],
+        yearly_ewr_results = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge', 'State', 'SWSDLName'],
                                 left_table=yearly_ewr_results,
                                 left_on=['gauge','pu','ewrCode'],
                                 selected_columns= ['Year', 'eventYears', 'numAchieved', 'numEvents', 'numEventsAll', 
                                             'eventLength', 'eventLengthAchieved', 'totalEventDays', 'totalEventDaysAchieved',
                                             'maxEventDays', 'maxRollingEvents', 'maxRollingAchievement',
                                             'missingDays', 'totalPossibleDays', 'ewrCode',
-                                            'scenario', 'gauge', 'pu', 'Multigauge'],
+                                            'scenario', 'gauge', 'pu', 'State', 'SWSDLName', 'Multigauge'],
                                 parameter_sheet_path=self.parameter_sheet)
 
         # Setting up the dictionary of yearly rolling maximum interevent periods:
         events_to_process = summarise_results.get_events_to_process(self.yearly_events)
         all_events_temp = summarise_results.process_all_events_results(events_to_process)
 
-        all_events_temp = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge'],
+        all_events_temp = summarise_results.join_ewr_parameters(cols_to_add=['Multigauge', 'State', 'SWSDLName'],
                                                                 left_table=all_events_temp,
                                                                 left_on=['gauge', 'pu', 'ewr'],
-                                                                selected_columns=['scenario', 'gauge', 'pu', 'ewr',
+                                                                selected_columns=['scenario', 'gauge', 'pu', 'State', 'SWSDLName', 'ewr',
                                                                                   'waterYear', 'startDate', 'endDate',
                                                                                   'eventDuration', 'eventLength',
                                                                                   'Multigauge'],