py-ewr 2.2.9__py3-none-any.whl → 2.3.1__py3-none-any.whl

py_ewr/scenario_handling.py

@@ -653,10 +653,10 @@ class ScenarioHandler:
         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)
@@ -673,10 +673,10 @@ class ScenarioHandler:
         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)
@@ -701,10 +701,10 @@ class ScenarioHandler:
         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)
@@ -723,10 +723,10 @@ class ScenarioHandler:
         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)
@@ -760,24 +760,24 @@ class ScenarioHandler:
         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', 'waterYear', 'startDate', 'endDate',
+                        selected_columns= ['scenario', 'gauge', 'pu', 'State', 'SWSDLName', 'ewr', 'waterYear', 'startDate', 'endDate',
                                 'eventDuration', 'eventLength', 
                                 'Multigauge'],
                         parameter_sheet_path=self.parameter_sheet)

py_ewr/summarise_results.py

@@ -414,11 +414,11 @@ def summarise(input_dict:Dict , events:Dict, parameter_sheet_path:str = None)->
                                                       right_on=['scenario', 'gauge','pu',"ewrCode"])
     # Join Ewr parameter to summary
 
-    final_merged = join_ewr_parameters(cols_to_add=['TargetFrequency','MaxInter-event','Multigauge'],
+    final_merged = join_ewr_parameters(cols_to_add=['TargetFrequency','MaxInter-event','Multigauge', 'State', 'SWSDLName'],
                                 left_table=final_summary_output,
                                 left_on=['gauge','pu','ewrCode'],
                                 selected_columns=["scenario",'gauge',
-                                                    'pu', 
+                                                    'pu', 'State', 'SWSDLName', 
                                                     'ewrCode',
                                                     'Multigauge',
                                                     'EventYears',
@@ -436,7 +436,7 @@ def summarise(input_dict:Dict , events:Dict, parameter_sheet_path:str = None)->
                                                     'MaxInter-event',
                                                     'NoDataDays',
                                                     'TotalDays'],
-                                renamed_columns=['Scenario','Gauge', 'PlanningUnit', 'EwrCode', 'Multigauge','EventYears', 'Frequency', 'TargetFrequency',
+                                renamed_columns=['Scenario','Gauge', 'PlanningUnit', 'State', 'SWSDLName', 'EwrCode', 'Multigauge','EventYears', 'Frequency', 'TargetFrequency',
                                     'AchievementCount', 'AchievementPerYear', 'EventCount', 'EventCountAll','EventsPerYear', 'EventsPerYearAll',
                                     'AverageEventLength', 'ThresholdDays', #'InterEventExceedingCount',
                                     'MaxInterEventYears', 'NoDataDays', 'TotalDays'],
@@ -507,7 +507,7 @@ def events_to_interevents(start_date: date, end_date: date, df_events: pd.DataFr
     # Create the unique ID field
     df_events['ID'] = df_events['scenario']+df_events['gauge']+df_events['pu']+df_events['ewr']
     unique_ID = df_events['ID'].unique()
-    all_interEvents = pd.DataFrame(columns = ['scenario', 'gauge', 'pu', 'ewr', 'ID', 
+    all_interEvents = pd.DataFrame(columns = ['scenario', 'gauge', 'pu', 'State', 'SWSDLName', 'ewr', 'ID', 
                                                 'startDate', 'endDate', 'interEventLength'])
 
     for i in unique_ID:
@@ -530,10 +530,12 @@ def events_to_interevents(start_date: date, end_date: date, df_events: pd.DataFr
             new_scenario = [contain_values['scenario'].iloc[0]]*length
             new_gauge = [contain_values['gauge'].iloc[0]]*length
             new_pu = [contain_values['pu'].iloc[0]]*length
+            new_state = [contain_values['State'].iloc[0]]*length
+            new_sdl = [contain_values['SWSDLName'].iloc[0]]*length
             new_ewr = [contain_values['ewr'].iloc[0]]*length
             new_ID = [contain_values['ID'].iloc[0]]*length
 
-            data = {'scenario': new_scenario, 'gauge': new_gauge, 'pu': new_pu, 'ewr': new_ewr, 'ID': new_ID, 'startDate': inter_starts, 'endDate': inter_ends}
+            data = {'scenario': new_scenario, 'gauge': new_gauge, 'pu': new_pu, 'State': new_state, 'SWSDLName': new_sdl, 'ewr': new_ewr, 'ID': new_ID, 'startDate': inter_starts, 'endDate': inter_ends}
 
             df_subset = pd.DataFrame(data=data)
 

{py_ewr-2.2.9.dist-info → py_ewr-2.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py_ewr
-Version: 2.2.9
+Version: 2.3.1
 Summary: Environmental Water Requirement calculator
 Home-page: https://github.com/MDBAuth/EWR_tool
 Author: Martin Job
@@ -20,21 +20,21 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Framework :: Pytest
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pandas >2
-Requires-Dist: requests >2
-Requires-Dist: mdba-gauge-getter ==0.5.1
-Requires-Dist: cachetools >5
+Requires-Dist: pandas>2
+Requires-Dist: requests>2
+Requires-Dist: mdba-gauge-getter==0.5.1
+Requires-Dist: cachetools>5
 Requires-Dist: xarray
 Requires-Dist: h5py
 Requires-Dist: netCDF4
-Requires-Dist: numpy <2
+Requires-Dist: numpy<2
 
 [![CI](https://github.com/MDBAuth/EWR_tool/actions/workflows/test-release.yml/badge.svg)]()
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/py-ewr)](https://pypi.org/project/py-ewr/)
 [![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.2.9 README**
+### **EWR tool version 2.3.1 README**
 
 ### **Notes on recent version updates**
 - 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
@@ -48,6 +48,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.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+py_ewr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_ewr/data_inputs.py,sha256=oUiEiLY_CmbvqF5GlV-3Yfz_JZ1qZNvta-VEYCzAcso,20124
+py_ewr/evaluate_EWRs.py,sha256=bAhFZTQZkoAE2eKgNIomm1LJdZ2HihoygUnXybtEdm4,231326
+py_ewr/io.py,sha256=Is0xPAzLx6-ylpTFyYJxMimkNVxxoTxUcknTk6bQbgs,840
+py_ewr/observed_handling.py,sha256=JTSK_2obhqNWJ2QknykywevNMN0fsvGXSejFwUSpMoA,18112
+py_ewr/scenario_handling.py,sha256=veaiQ6vfQX40laUk3eEUFWqO3wceP76Wh92HhJFsl8A,35762
+py_ewr/summarise_results.py,sha256=rFaAUVR4jIsjeRl4ocPFE2RUoJJBZgZ2wPEBh-dfEsc,31761
+py_ewr/model_metadata/SiteID_MDBA.csv,sha256=QDIW21IFX1MYxDvs6Aja-OOUBhgnNa8l-NnCpQMmBl4,168430
+py_ewr/model_metadata/SiteID_NSW.csv,sha256=UVBxN43Z5KWCvWhQ5Rh6TNEn35q4_sjPxKyHg8wPFws,6805
+py_ewr/model_metadata/iqqm_stations.csv,sha256=vl4CPtPslG5VplSzf_yLZulTrmab-mEBHOfzFtS1kf4,110
+py_ewr/parameter_metadata/ewr2obj.csv,sha256=r2uXzhZ-Rd1u3RLhNXmJnPYcHwouHBehEPnvednfz-I,3948677
+py_ewr/parameter_metadata/ewr_calc_config.json,sha256=l1AgIRlf7UUmk3BNQ4r3kutU48pYHHVKmLELjoB-8rQ,17664
+py_ewr/parameter_metadata/obj2target.csv,sha256=f6kLVyBhXUpGR4b0dzLbBvZbfpn3OxOhaB4aouO6Bvw,1593877
+py_ewr/parameter_metadata/obj2yrtarget.csv,sha256=G8XgdCrOpB0xhp6n7DIS4Vcq69Kpgb1Pum7Ay3a_YPU,54882
+py_ewr/parameter_metadata/parameter_sheet.csv,sha256=MxKE-649bIC6HGqh87MT_fR3Lmew8n10Oi6OsAF1N0Q,768524
+py_ewr-2.3.1.dist-info/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
+py_ewr-2.3.1.dist-info/METADATA,sha256=QAW_W9RLEq6SXwpl68WRObU7cEUq_MCpygk8cDkAFtQ,12585
+py_ewr-2.3.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+py_ewr-2.3.1.dist-info/top_level.txt,sha256=n3725d-64Cjyb-YMUMV64UAuIflzUh2_UZSxiIbrur4,7
+py_ewr-2.3.1.dist-info/RECORD,,

{py_ewr-2.2.9.dist-info → py_ewr-2.3.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

py_ewr-2.2.9.dist-info/RECORD

@@ -1,20 +0,0 @@
-py_ewr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-py_ewr/data_inputs.py,sha256=OLIxqq15yoEqLSRmBJP37erldUGRRvSNn2XwO8LKZA8,20080
-py_ewr/evaluate_EWRs.py,sha256=bAhFZTQZkoAE2eKgNIomm1LJdZ2HihoygUnXybtEdm4,231326
-py_ewr/io.py,sha256=Is0xPAzLx6-ylpTFyYJxMimkNVxxoTxUcknTk6bQbgs,840
-py_ewr/observed_handling.py,sha256=aVQYI8Qs-v5DZOA_r8bYluE3ilgM7Vjygs29jA6kpaA,17848
-py_ewr/scenario_handling.py,sha256=95HdNNPkY-w77hxnHRJxfzmn9fBu6OqHM5iyoQPwOXE,35498
-py_ewr/summarise_results.py,sha256=CEHsx6hC5UidgYy-dCJW_buiktGKkTH9D_Yl5QpSzh8,31499
-py_ewr/model_metadata/SiteID_MDBA.csv,sha256=GHDuO7pnk4JrlCOG5aBw77bD0HxvEU_-NQ0kT9CKDrU,167724
-py_ewr/model_metadata/SiteID_NSW.csv,sha256=UVBxN43Z5KWCvWhQ5Rh6TNEn35q4_sjPxKyHg8wPFws,6805
-py_ewr/model_metadata/iqqm_stations.csv,sha256=vl4CPtPslG5VplSzf_yLZulTrmab-mEBHOfzFtS1kf4,110
-py_ewr/parameter_metadata/ewr2obj.csv,sha256=TyUDM_lzTu2v50j-kx-cvcX4QpwC0Vbc5pGFMG6rtMQ,4583480
-py_ewr/parameter_metadata/ewr_calc_config.json,sha256=l1AgIRlf7UUmk3BNQ4r3kutU48pYHHVKmLELjoB-8rQ,17664
-py_ewr/parameter_metadata/obj2target.csv,sha256=DIcwrOyvNPhBdvplWb8GU-2Hu33NwYhrXenAbnRD-dM,1773425
-py_ewr/parameter_metadata/obj2yrtarget.csv,sha256=x-lvGTHMsXutSKfgN6_B0ujQueiu953lEk-_k8ybTNw,56681
-py_ewr/parameter_metadata/parameter_sheet.csv,sha256=Pm741CUDywFJ_Jd8LN41YcimKvne-ey-gJskI13wTIk,772287
-py_ewr-2.2.9.dist-info/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
-py_ewr-2.2.9.dist-info/METADATA,sha256=tCty8mRuqb3xrgURdtZXlOpyaeu5CkL_-2I34lPlCSA,12521
-py_ewr-2.2.9.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-py_ewr-2.2.9.dist-info/top_level.txt,sha256=n3725d-64Cjyb-YMUMV64UAuIflzUh2_UZSxiIbrur4,7
-py_ewr-2.2.9.dist-info/RECORD,,