py-ewr 2.1.2__py3-none-any.whl → 2.1.5__py3-none-any.whl

py_ewr/model_metadata/SiteID_MDBA.csv

@@ -80,10 +80,11 @@ SITEID,Name,Description,AWRC,StateID
 422401,Maranoa River @ Mitchell,,422401,1
 422404A,Maranoa River @ Cashmere,,422404,1
 422407C,Maranoa River @ Forestvale,,422407,1
-423003_,Warrego River @ Barringun,,423003,2
+423003,Warrego River @ Barringun,,423004,2
+423003_,Warrego River @ Barringun,,423004,2
 423201A,Warrego River @ Charleville,,423201A,1
 423202C,Warrego River @ Cunnamulla,,423202C,1
-423203A,Warrego River @ Wyandra,,423203,
+423203A,Warrego River @ Wyandra,,423203     ,
 423204_,Warrego River @ Augathella,,423204,
 424002_,Paroo River @ Willara Crossing,,424002,
 4261125,Wellington @ Top Surface,,,5
@@ -237,7 +238,8 @@ BARNXNY,Vic Barmah to Nyah �exc. Nyah Pumps,Victorian Barmah to Nyah diversion
 BARNYAH,Barmah to Nyah - Murray River,Barmah to Nyah - Murray River,,4
 BAROONA,Macquarie River @ Baroona,,421127,2
 BARPRES,Barwon River u/s Presbury Weir,Barwon River u/s Presbury Weir,416050,2
-BARRAGE,Barrages near the Murray Mouth,,,5
+9GSPRES,Barwon River u/s Presbury Weir,Barwon River u/s Presbury Weir,416050,2
+BARRAGE,Barrages near the Murray Mouth,,A4261002,5
 BARRASP,Airspace in Barr Creek Disposal Basins,,,4
 BARRATT,Edward River D/S of Barratta.,Edward River Downstream of Barratta.,,2
 BARRCK,Barr Creek D/S of Pumps,,,4
@@ -259,6 +261,7 @@ BCKRWDO,Broken Creek at Rice's Weir deemed irrigation retu,,,4
 BDGRWP,Bendigo RWP,,,4
 BECTIVE,Peel River @ Bective,Peel River @ Bective,419074,1
 BEEMERY,Barwon River @ Beemery (u/s Culgoa Junction),,422028,2
+9GSBEEM,Barwon River @ Beemery (u/s Culgoa Junction),,422028,2
 BELLFIE,Lake Bellfields - Wimmera Mallee,,,4
 BELNEW,Bell River @ Newrea,Bell River @ Newrea,421018,2
 BELTONS,Beltons,Hattah Lakes System - manual data collection in the lakes,,
@@ -335,11 +338,13 @@ BORDRRN,Border Rivers System - New South Wales,,,2
 BORDRRQ,Border Rivers Cap Valley - Queensland,"Border Rivers Cap Valley - Queensland - includes Border River, Weir River and Macintyre Brook",,1
 BORDRV,Border Rivers in Queensland,Border Rivers excluding Weir river in Queensland in Border River System,,1
 BOROMA,Barwon River @ Boorooma (u/s Macquarie Junction),,422026,2
+9GSBOOR,Barwon River @ Boorooma (u/s Macquarie Junction),,422026,2
 BORWEIR,Border Rivers including Weir River in QLD,Border Rivers including Weir River in Border River System Queensland,,1
 BOUBEND,River Murray at Boundary Bend,,414201B,2
 BOUNDCK,Lake Alexandrina U/S Boundary Ck Barrage,,,5
 BOUNDDS,Boundary Creek D/S Boundary Creek Barrage,Boundary Creek downstream Boundary Creek Barrage,A4261044,5
 BOURKE,Darling River at Bourke,,425003,2
+9GSBOUR,Darling River at Bourke,,425003,2
 BOWKILN,Bowls Kiln,Millewa monitoring site,,
 BOWLERS,Mitta Mitta River at Bowlers Lane,,401222,
 BOXBARR,Box Creek at Barratta Dam,,409059,2
@@ -385,6 +390,7 @@ BRENDA,Culgoa River at Brenda,BSMS EOV target site,422015,2
 BRESDRN,BERRI EAST DRAINAGE OUTFALL,BERRI EAST DRAINAGE OUTFALL DIRECTLY TO R.MURRAY,,5
 BRESTP,Brewarrina STP,,,2
 BREWARR,Barwon River at Brewarrina,,422002,2
+9GSBREW,Barwon River at Brewarrina,,422002,2
 BREWTOT,Barwon R Brewarrina ( total flow ),,422023,2
 BRGSTP,Bellbridge STP,,,4
 BRHAMET,Broken Hill Airport MET,Broken Hill Airport AWS. 2.8 Km from closed Site BROKMET,47048,2
@@ -454,6 +460,7 @@ CADESC3,Cadow No. 3 Escape,,,2
 CADLDRN,Cadell LWMP Drains,Cadell Land and Water Management Plan Drains,,
 CADPUM,Cadell - Blanchetown Pipeline,,,
 CAIRNCU,Loddon River at Cairn Curran Reservoir,Cairn Curran Reservoir - Loddon River,407210,4
+424201A,Paroo R at Caiwarro,Paroo R at Caiwarro - Queensland,424201A,1
 CAIWARR,Paroo R at Caiwarro,Paroo R at Caiwarro - Queensland,424201A,1
 CALFCK,Calf Creek River Regulator U/S Forest Side,New South Wales Regulators - Koondrook-Perricoota Forest,,2
 CALIVIL,Calivil Creek at Wisharts Road,Calivil Creek at Wisharts Road,407284,4
@@ -591,6 +598,7 @@ COLIBAS,Campaspe River - Coliban System,,,4
 COLIGNA,River Murray at Colignans,,414207A,4
 COLIPON,Murray River at Colignan - pontoon,Murray River at Colignan - pontoon,41310022,4
 COLLARE,Barwon River at Collarenebri Main Channel,Barwon River @ Collarenebri Main Channel,422003,2
+9GSCOLL,Barwon River at Collarenebri Main Channel,Barwon River @ Collarenebri Main Channel,422003,2
 COLLBRI,Mehi River Near Collarenebri,,418055,2
 COLLEAM,Colleambally,Colleambally - Murrumbidgee River System,,2
 COLLELD,CIA Diversion,,,2
@@ -854,6 +862,7 @@ FOAPMET,Forbes Apt,,65103,2
 FORBES,Lachlan River - Forbes (Cottons Weir),,412004,2
 FORBMET,Forbes (Camp Street),,65016,2
 FORDSBR,WARREGO RIVER AT FORDS BRIDGE (MN CHANN),,423001,2
+423001_,WARREGO RIVER AT FORDS BRIDGE (MN CHANN),,423001,2
 FORDSBY,WARREGO RIVER - FORDS BRIDGE (BYWASH),,423002,2
 FOREST,Barmah-Millewa Regulator Openings,PERCENTAGE OF REGULATORS THAT ARE OPEN,,4
 FORHSTP,Forest Hill STP (Wagga Wagga),,,2
@@ -977,6 +986,7 @@ GUMCOW,Gum Cowal @ Bifurcation,Gum Cowal @ Bifurcation,421146,2
 GUNBENV,Gunbower Creek Environmental Releases,Releases for environmental watering of riverine wetlands,,4
 GUNCOXY,Gum Cowal @ Oxley,Gum Cowal @ Oxley,421152,2
 GUNDABA,MOONIE RIVER - GUNDABLOUIE,,417001,
+417001_,MOONIE RIVER - GUNDABLOUIE,,417001,
 GUNDAGI,MURRUMBIDGEE RIVER - GUNDAGAI,,410004,2
 GUNDSTP,Gundagai STP,,,2
 GUNFORE,Gunbower forest system,added to capture environmental water for the Gunbower system,GUNFORE,4
@@ -1306,11 +1316,11 @@ LOCK5DS,River Murray D/S Lock 5,,426513,5
 LOCK5US,River Murray U/S Lock 5,SAMPLE AT GAUGING STATION,426512,5
 LOCK6DS,River Murray D/S Lock 6,,426511,5
 LOCK6US,River Murray U/S Lock 6,,426510,5
-LOCK7DS,River Murray D/S Lock 7,,4260509,5
-LOCK7US,River Murray U/S Lock 7,,426508,5
-LOCK8DS,River Murray D/S Lock 8,,4260507,5
-LOCK8US,River Murray U/S Lock 8,,426506,5
-LOCK9DS,River Murray D/S Lock 9,,4260505,5
+LOCK7DS,River Murray D/S Lock 7,,A4260509,5
+LOCK7US,River Murray U/S Lock 7,,A4260508,5
+LOCK8DS,River Murray D/S Lock 8,,A4260507,5
+LOCK8US,River Murray U/S Lock 8,,A4260506,5
+LOCK9DS,River Murray D/S Lock 9,,A4260505,5
 LOCK9US,River Murray U/S Lock 9,SAMPLE AT GAUGING STATION,A4260501,5
 LOCKING,Lockington Main Drain,Lockington Main Drain Shepparton,407712,4
 LOCKRIC,Lockington Main Drain adj to Richardsons,Lockington Main Drain adjacent to Richardsons,,4
@@ -1330,6 +1340,7 @@ LODWWMC,Loddon River - WWMC,,,4
 LONSDAL,Lake Lonsdale - Wimmera Mallee,,,4
 LOUSYCR,Lousy Crossing,Millewa monitoring site,,
 LOUTH,Darling River at Louth,,425004,2
+9GSLOUT,Darling River at Louth,,425004,2
 LOVEBAS,Loveday Outfall at Loveday Evaporation Basin,Loveday Outfall at Loveday Evaporation Basin,A4260698,5
 LOVECAU,Loveday Swamp at Cit Causeway Southern Basin,Loveday Swamp at Cit Causeway Southern Basin,A4261088,5
 LOVECOB,Loveday Disposal Basin at Cobdogla Swamp,Loveday Disposal Basin at Cobdogla Swamp,A4261081,5
@@ -1534,6 +1545,7 @@ MNCKUMB,"Manna Creek, upstream Manna bridge",,,2
 MNTESC,1 McNight,,,4
 MNWDRM,Merbein North-West Drain,Merbein North-West Drain @ U/S of Outfall to Murray River,414706,4
 MOGIL,Barwon River at Mogil Mogil,,422004,2
+9GSMOGI,Barwon River at Mogil Mogil,,422004,2
 MOIRACK,Moira Creek River Regulator,River Regulator settings - Murray River - Barmah forest - NSW National Parks,,2
 MOIRADS,Moira Creek D/S,Millewa monitoring site,,
 MOIRALW,Moira Lake West,Millewa monitoring site,,
@@ -1576,7 +1588,7 @@ MORTBLK,Morton Boulka Lake,,,2
 MORTOMB,Morgan to Murray Bridge Reach,,,
 MOULAME,Edward River at Moulamein,,409014,4
 MOULMET,Moulamein Post Office Met Station,,75046,4
-MOUTH,Murray Mouth,,,5
+MOUTH,Murray Mouth,,A4260527,5
 MPNSTP,Mooroopna STP,,,4
 MRLPUMP,Murray River Level @ Main Hattah Pump Station,,MRLPUMP,
 MRUFUSR,River Murray D/S Rufus River,,426200A,5
@@ -2125,6 +2137,7 @@ TALMALM,Murray R @ Talmalmo,Thermal Analysis Site,,2
 TALPILE,TALPILE,Lake Talpile in the Poon Boon system,,2
 TALSTP,Tallangatta STP,,,4
 TALYBH,TALYAWALKA CREEK AT BARRIER HIGHWAY,TALYAWALKA CREEK AT BARRIER HIGHWAY,425018,4
+9GSBARR,TALYAWALKA CREEK AT BARRIER HIGHWAY,TALYAWALKA CREEK AT BARRIER HIGHWAY,425018,4
 TALYRLB,Talyawalka Creek at Rail Bridge,Bypass Flow around Menindee Lakes,,
 TAMFIE,Thales Australia Munitions Factory,,,2
 TAMSTP,Tamworth STP - Westdale & Swan St Plants,,,2
@@ -2144,6 +2157,7 @@ TANREDB,Tandou Diversions from Redbank Creek,Tancaw + Tanover,,2
 TANTANG,Tantangara Reservoir on Murrumbidgee,Snowy Hydro Limited,,2
 TAPIO,DARLING River AT TAPIO,,42510050,
 TARA,Barwon River @ Tara (u/s Namoi Junction),Barwon River @ Tara (u/s Namoi Junction),422025,2
+9GSTARA,Barwon River @ Tara (u/s Namoi Junction),Barwon River @ Tara (u/s Namoi Junction),422025,2
 TARADWN,Great Darling River at Tara Downs,,425054,2
 TARASTP,Tara STP,,,1
 TARCOOL,RIVER MURRAY - TARCOOLA,,,
@@ -2181,6 +2195,7 @@ THURK,Thurk island (SA),Thurk island (SA),,5
 TIDBMET,Tidbinbilla Meteo Station,,70310,3
 TILLMET,Balranald (Tillara),,49048,2
 TILPA,Darling River @ Tilpa,Sample @ Gauging Station,425900,2
+9GSTILP,Darling River @ Tilpa,Sample @ Gauging Station,425900,2
 TINHUT,Tin Hut,Millewa monitoring site,,
 TMPLTON,RIVER MURRAY - TEMPLETON,,4260632,5
 TOCDOF,Toolamba Community Drain,,,4
@@ -2369,6 +2384,7 @@ WALBUND,Billabong Creek at Walbundrie Station,,410091,2
 WALEAST,Wallawalla east regulator,,,
 WALGET2,Barwon River at Walgett (Hannafords),,422009,2
 WALGETT,Barwon River at Walgett (Dangar Bridge),,422001,2
+9GSWALG,Barwon River at Walgett (Dangar Bridge),,422001,2
 WALGSTP,Walgett STP,,,2
 WALHLDS,Wallpolla Horseshoe Lagoon regulator D/S,,,
 WALKERF,River Murray at Walker Flat,,426548,5
@@ -2387,6 +2403,7 @@ WANDELF,Wandell Creek at Fairly,WANDELL CREEK AT FAIRLY,407286,4
 WANGARA,Ovens River (ONLY) - Wangaratta,,403200,4
 WANGSTP,Wangaratta STP,,,4
 WANWIM,Wannon River Catchment to Wimmera-Mallee,,,4
+9GSWARR,Darling River @ Warraweena (d/s Culgoa Junction),,425039,2
 WARAWEN,Darling River @ Warraweena (d/s Culgoa Junction),,425039,2
 WARESC9,Warroo No.9 Escape,,,2
 WARGNSW,Warrego River in NSW,,,1
@@ -2454,12 +2471,14 @@ WIDGEON,River Murray @ Widgeon,,409039,4
 WILCAN,Darling River at Wilcannia (Total Flow),,425002,2
 WILCMET,Wilcannia Met Station,From 10/1/2015 we are using above site as - 46012 Wilcannia Aerodrome Automatic water station (AWS),46043,2
 WILCMNC,Main Darling Channel at Wilcannia,,425008,2
+9GSWILC,Main Darling Channel at Wilcannia,,425008,2
 WILDDOG,Wild Dog Creek,Millewa monitoring site,,
 WILKDLW,Wilkinsons Dr @ Lake Wandella,Kerang Lakes - Wilkinsons Dr at Lake Wandella,407758,4
 WILLHOV,Lake William Hovell - Ovens River,,403234A,4
 WILLIAM,Lake William,,,
 WILMSTO,Williamstown Met Stn,Williamstown Meteorological Stn,23572,4
 WIMHOR,Wimmera River @ Horsham Weir (Victoria),Wimmera River at Horsham (Victoria),415200,4
+415200,Wimmera River @ Horsham Weir (Victoria),Wimmera River at Horsham (Victoria),415200,4
 WIMMALL,Wimmera Mallee - Diversions,,,4
 WIMMDIM,Wimmera River U/S of Dimboola,Wimmera River U/S of Dimboola,415256A,4
 WINDAME,Windamere Reservoir - Cudgegong River,,,2
@@ -2598,15 +2617,19 @@ __WRYC1,__WRYC1,Wimmera River System Model Node WR_YC1,__WRYC1,4
 1AS,1AS,"Yanga (South  Redbank), combined 1AS and 1ES regulators",1AS,2
 422207A,422207A,Hebel-Bollon Road GS (Node C),422207A,1
 422209A,422209A,Hebel GS (Node D),422209A,1
-LOCK8US,A4260505,Murray downstream Lock 9  ,A4260505,5
-LOCK8DS,A4260507,Murray downstream Lock 8 ,A4260507,5
-LOCK6US - Natural,A4260509,Murray downstream Lock 7 ,A4260509,5
-MOUTH,A4260527,Barrages near the Murray Mouth,A4260527,5
-FLOWSA ,A4261001,Flow at South Australia border,A4261001,5
-BARRAGE,A4261002,Barrages near the Murray Mouth,A4261002,5
+FLOWSA,A4261001,Flow at South Australia border,A4261001,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
 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
 Pumped from Yanga Lake,Pumped from Yanga Lake,Yanga (South  Redbank),Pumped from Yanga Lake,2
+424201A,Warrego Paroo Bulloo and Nebine Long-term watering plan,Paroo River at Caiwarro,424201A,1
+6GRAVEG,GWYDIR RIVER - GRAVESEND ROAD BRIDGE,Gwydir River @ Gravesend Road Bridge, 418013,2
+6FDSCOP,GWYDIR RIVER D/S COPETON DAM,_,418026,2
+6YARMAN,Gwydir River @ Yarraman Bridge,_,418004,2
+6MOREEG,MEHI RIVER AT MOREE,_,418002,2
+6COLARG,Mehi River Near Collarenebri,_,418055,2
+6MALLWA,Mallowa Creek @ Regulator,Mallowa Creek @ Regulator,418049,2
+6CAROLG,418011,Carole downstream Regulator Gwydir,418011,2
+6GARAHG,Carole Creek Outflow -Gwydir System,Carole Creek @ near Garah,418052,2

py_ewr/scenario_handling.py

@@ -16,27 +16,6 @@ log.addHandler(logging.NullHandler())
 from . import data_inputs, evaluate_EWRs, summarise_results
 #----------------------------------- Scenario testing handling functions--------------------------#
 
-# def gauge_only_column(df: pd.DataFrame) -> pd.DataFrame:
-#     '''Ingesting scenario file locations with a standard timeseries format,
-#     returns a dictionary of flow dataframes with their associated header data
-    
-#     Args:
-#         csv_file (str): location of model file
-
-#     Results:
-#         pd.DataFrame: model file converted to dataframe
-#     '''
-    
-#     siteList = []
-#     for location in df.columns:
-#         gauge = extract_gauge_from_string(location)
-#         siteList.append(gauge)
-#     # Save over the top of the column headings with the new list containing only the gauges
-#     df.columns = siteList
-    
-#     return df
-    
-
 def unpack_model_file(csv_file: str, main_key: str, header_key: str) -> tuple:
     '''Ingesting scenario file locations of model files with all formats (excluding standard timeseries format), seperates the flow data and header data
     returns a dictionary of flow dataframes with their associated header data
@@ -236,7 +215,8 @@ def cleaner_NSW(input_df: pd.DataFrame) -> pd.DataFrame:
         cleaned_df['Date'] = pd.to_datetime(cleaned_df['Date'], format = '%d/%m/%Y')
         cleaned_df['Date'] = cleaned_df['Date'].apply(lambda x: x.to_period(freq='D'))
     except ValueError:
-        log.info('Attempted and failed to read in dates in format: dd/mm/yyyy, attempting to look for dates in format: yyyy-mm-dd')
+        log.info('''Attempted and failed to read in dates in format: dd/mm/yyyy, 
+        attempting to look for dates in format: yyyy-mm-dd''')
         try:
             cleaned_df['Date'] = pd.to_datetime(cleaned_df['Date'], format = '%Y-%m-%d')
             cleaned_df['Date'] = cleaned_df['Date'].apply(lambda x: x.to_period(freq='D'))
@@ -250,6 +230,51 @@ def cleaner_NSW(input_df: pd.DataFrame) -> pd.DataFrame:
 def cleaner_standard_timeseries(input_df: pd.DataFrame, ewr_table_path: str = None) -> pd.DataFrame:
     '''Ingests dataframe, removes junk columns, fixes date, allocates gauges to either flow/level
     
+    Args:
+        input_df (pd.DataFrame): flow/water level dataframe
+
+    Results:
+        tuple[pd.DataFrame, pd.DataFrame]: Cleaned flow dataframe; cleaned water level dataframe
+
+    '''
+
+    cleaned_df = input_df.copy(deep=True)
+    try:
+        cleaned_df.index = pd.to_datetime(cleaned_df.index, format = '%d/%m/%Y')
+    except ValueError:
+        log.info('''Attempted and failed to read in dates in format: dd/mm/yyyy, attempting
+        to look for dates in format: yyyy-mm-dd''')
+        try:
+            cleaned_df.index = pd.to_datetime(cleaned_df.index, format = '%Y-%m-%d')
+        except ValueError:
+            raise ValueError('''New date format detected. Cannot read in data''')
+        log.info('''Successfully read in data with yyyy-mm-dd formatting''')
+
+    # If there are missing dates, add in the dates and fill with NaN values
+    dates = pd.date_range(start = cleaned_df.index[0], end=cleaned_df.index[-1])
+    cleaned_df = cleaned_df.reindex(dates)
+
+    # TODO: Optional: add in gap filling code if user selects preference for gap filling
+
+    df_flow = pd.DataFrame(index = cleaned_df.index)
+    df_level = pd.DataFrame(index = cleaned_df.index)
+    df_flow.index.name = 'Date'
+    df_level.index.name = 'Date'
+
+    for gauge in cleaned_df.columns:
+        gauge_only = extract_gauge_from_string(gauge)
+        if 'flow' in gauge:
+            df_flow[gauge_only] = cleaned_df[gauge].copy(deep=True)
+        if 'level' in gauge:
+            df_level[gauge_only] = cleaned_df[gauge].copy(deep=True)
+        if not gauge_only:
+            log.info('Could not identify gauge in column name:', gauge, ', skipping analysis of data in this column.')
+    return df_flow, df_level
+
+
+def cleaner_ten_thousand_year(input_df: pd.DataFrame, ewr_table_path: str = None) -> pd.DataFrame:
+    '''Ingests dataframe, removes junk columns, fixes date, allocates gauges to either flow/level
+    
     Args:
         input_df (pd.DataFrame): flow/water level dataframe
 
@@ -271,7 +296,6 @@ def cleaner_standard_timeseries(input_df: pd.DataFrame, ewr_table_path: str = No
         except ValueError:
             raise ValueError('New date format detected. Cannot read in data')
         log.info('successfully read in data with yyyy-mm-dd formatting')
-    
     date_range = pd.period_range(date_start, date_end, freq = 'D')
     cleaned_df['Date'] = date_range
     cleaned_df = cleaned_df.set_index('Date')
@@ -330,7 +354,8 @@ def match_MDBA_nodes(input_df: pd.DataFrame, model_metadata: pd.DataFrame, ewr_t
                 df_flow[gauge] = input_df[col]
             if gauge in level_gauges and measure == '35':
                 df_level[gauge] = input_df[col]
-
+    if df_flow.empty:
+        raise ValueError('No relevant gauges and or measurands found in dataset, the EWR tool cannot evaluate this model output file')      
     return df_flow, df_level
 
 def match_NSW_nodes(input_df: pd.DataFrame, model_metadata: pd.DataFrame) -> tuple:
@@ -405,11 +430,12 @@ class ScenarioHandler:
                             bar_format='{l_bar}{bar:10}{r_bar}{bar:-10b}',
                             desc= 'Evaluating scenarios'):
             if self.model_format == 'Bigmod - MDBA':
+                
                 data, header = unpack_model_file(scenarios[scenario], 'Dy', 'Field')
                 data = build_MDBA_columns(data, header)
                 df_clean = cleaner_MDBA(data)
                 df_F, df_L = match_MDBA_nodes(df_clean, data_inputs.get_MDBA_codes(), self.parameter_sheet)
-
+                               
             elif self.model_format == 'Standard time-series':
                 df = pd.read_csv(scenarios[scenario], index_col = 'Date')
                 df_F, df_L = cleaner_standard_timeseries(df, self.parameter_sheet)
@@ -419,9 +445,18 @@ class ScenarioHandler:
                 data = build_NSW_columns(data, header)
                 df_clean = cleaner_NSW(data)
                 df_F, df_L = match_NSW_nodes(df_clean, data_inputs.get_NSW_codes())
+
+            elif self.model_format == 'ten thousand year':
+                df = pd.read_csv(scenarios[scenario], index_col = 'Date')
+                df_F, df_L = cleaner_ten_thousand_year(df, self.parameter_sheet)
+
+            elif self.model_format == 'Source - Qld':
+                df = pd.read_csv(scenarios[scenario], index_col = 'Date')
+                df_F, df_L = cleaner_Qld_source(data)
             
             gauge_results = {}
             gauge_events = {}
+
             all_locations = set(df_F.columns.to_list() + df_L.columns.to_list())
             EWR_table, bad_EWRs = data_inputs.get_EWR_table(self.parameter_sheet)
             calc_config = data_inputs.get_ewr_calc_config(self.calc_config_path)
@@ -429,9 +464,7 @@ class ScenarioHandler:
                 gauge_results[gauge], gauge_events[gauge] = evaluate_EWRs.calc_sorter(df_F, df_L, gauge,
                                                                                         EWR_table, calc_config) 
             detailed_results[scenario] = gauge_results
-            #print(detailed_results)
             detailed_events[scenario] = gauge_events
-            #print(detailed_events)
             self.pu_ewr_statistics = detailed_results
             self.yearly_events = detailed_events
             

py_ewr/summarise_results.py

@@ -569,20 +569,18 @@ def filter_successful_events(all_events: pd.DataFrame, ewr_table_path: str = Non
     # Iterate over the all_events dataframe
     for i in unique_ID:
         # Subset df with only 
-        df_subset = all_events[all_events['ID'].str.fullmatch(i)]
+        df_subset = all_events[all_events['ID'] == i]
         gauge = i.split('TEMPORARY_ID_SPLIT')[1]
         pu = i.split('TEMPORARY_ID_SPLIT')[2]
-        ewr = i.split('TEMPORARY_ID_SPLIT')[3]       
+        ewr = i.split('TEMPORARY_ID_SPLIT')[3]      
 
         # Pull EWR minSpell value from EWR dataset
         minSpell = int(data_inputs.ewr_parameter_grabber(EWR_table, gauge, pu, ewr, 'MinSpell'))
         # Filter out the events that fall under the minimum spell length
-        df_subset = df_subset.drop(df_subset[df_subset.eventDuration <= minSpell].index)
-
+        df_subset = df_subset.drop(df_subset[df_subset.eventDuration < minSpell].index)
         # Append to master dataframe
         all_successfulEvents = pd.concat([all_successfulEvents, df_subset], ignore_index=True)
     all_successfulEvents.drop(['ID', 'multigaugeID'], axis=1, inplace=True)
-
     return all_successfulEvents
 
 def get_rolling_max_interEvents(df:pd.DataFrame, start_date: date, end_date: date, yearly_df: pd.DataFrame, ewr_table_path: str = None) -> pd.DataFrame:
@@ -605,8 +603,8 @@ def get_rolling_max_interEvents(df:pd.DataFrame, start_date: date, end_date: dat
     # Load in EWR table to variable to access start and end dates of the EWR
     EWR_table, bad_EWRs = data_inputs.get_EWR_table(ewr_table_path)
     for unique_EWR in unique_ID:
-        df_subset = df[df['ID'].str.fullmatch(unique_EWR)]
-        yearly_df_subset = yearly_df[yearly_df['ID'].str.fullmatch(unique_EWR)]
+        df_subset = df[df['ID'] == unique_EWR]
+        yearly_df_subset = yearly_df[yearly_df['ID'] == unique_EWR]
         # Get EWR characteristics for current EWR
         scenario = unique_EWR.split('TEMPORARY_ID_SPLIT')[0]
         gauge = unique_EWR.split('TEMPORARY_ID_SPLIT')[1]

{py_ewr-2.1.2.dist-info → py_ewr-2.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py_ewr
-Version: 2.1.2
+Version: 2.1.5
 Summary: Environmental Water Requirement calculator
 Home-page: https://github.com/MDBAuth/EWR_tool
 Author: Martin Job
@@ -32,12 +32,12 @@ Requires-Dist: cachetools ==5.2.0
 [![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.1.2 README**
+### **EWR tool version 2.1.5 README**
 
-### **Notes on recent updates**
-- Ability to pass a climte categorisation file has been removed. No EWRs require climate categorisation anymore so this feature was redundant.
-- Ability to pass an allowance on some parts of the parameter sheet. This feature was not transparent and resulted in some counter-intuitive results in many cases so the feature has been removed during this update. If users are interested in assessing partial success through an allowance feature we recommend downloading the parameter sheet, making the required modifications (e.g. multiplying the duration column by a factor of 0.9 to simulate a 10% allowance), and running the EWR tool with this.
-- Ability to pass multiple model scenarios to the package has been removed. It is recommended to use an alternative method if you want to send multiple scenarios to the package. An example has been provided below by calling the EWR tool package in a loop. This has been implemented because some scenarios may have multiple different files and this was the cleanest way to account for this.
+### **Notes on recent version update**
+- 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.
+- ten thousand year handling - the same formatting as above is required (gauge_flow OR gauge_level)
+- 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.
 
 ### **Installation**
 

{py_ewr-2.1.2.dist-info → py_ewr-2.1.5.dist-info}/RECORD

@@ -2,14 +2,14 @@ py_ewr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py_ewr/data_inputs.py,sha256=BLJrrasZYpSUkC0yVBzVqnz6WGT2Y3SJYJJhguDi-Vo,18046
 py_ewr/evaluate_EWRs.py,sha256=1JYWNtw5MYgf92jXhDNlgGkDx2mcfBP34OO-0jgal1w,229279
 py_ewr/observed_handling.py,sha256=NaySsqe8nWgZdDRSr22EYmCwf0uNzVj9DFF6hzNr6ws,18173
-py_ewr/scenario_handling.py,sha256=QfUTpFr4uylTcoIDEjQJi2YZfydQR1I0ayorGJKFNkk,26399
-py_ewr/summarise_results.py,sha256=4IsRBfWP6XQvLRU2TUrY8lIGwlD1JMpmbEkbIWUaE4k,29787
-py_ewr/model_metadata/SiteID_MDBA.csv,sha256=OR2fUIwU8ei85Nq6nZxb_ozC4q9scATrnqED21PlGRM,162848
+py_ewr/scenario_handling.py,sha256=BNMKQmDIcT7mYd0jnSGUBfcZ2AzCvxgHGwJA9KxyQ_A,28184
+py_ewr/summarise_results.py,sha256=7w2Tbriwob21UXG0N2rSKffneg3M49hWouJPTHVjDAU,29747
+py_ewr/model_metadata/SiteID_MDBA.csv,sha256=ZVY_P-lq_tHNELfUrTTveNPWcumKHot7yWvdjje0I2k,164412
 py_ewr/model_metadata/SiteID_NSW.csv,sha256=UVBxN43Z5KWCvWhQ5Rh6TNEn35q4_sjPxKyHg8wPFws,6805
 py_ewr/parameter_metadata/ewr_calc_config.json,sha256=BkuSJI6NqZzJxZMd8eh3GBs5uoHfI2joOkPrKLu9-60,17556
 py_ewr/parameter_metadata/parameter_sheet.csv,sha256=ufOYn59cS4kl9XF1WaNqBhodcsBxUWH8Y0g1qHVUAcg,594257
-py_ewr-2.1.2.dist-info/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
-py_ewr-2.1.2.dist-info/METADATA,sha256=a-gfT0nKlAbWRwRSx9GMnjo4GQocz4LctPEatn9eE_4,10070
-py_ewr-2.1.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-py_ewr-2.1.2.dist-info/top_level.txt,sha256=n3725d-64Cjyb-YMUMV64UAuIflzUh2_UZSxiIbrur4,7
-py_ewr-2.1.2.dist-info/RECORD,,
+py_ewr-2.1.5.dist-info/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
+py_ewr-2.1.5.dist-info/METADATA,sha256=Sw5eAbah1SeV6Bd4BUCOXOqgEl6QgHSdaAg79Qixp5k,9570
+py_ewr-2.1.5.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+py_ewr-2.1.5.dist-info/top_level.txt,sha256=n3725d-64Cjyb-YMUMV64UAuIflzUh2_UZSxiIbrur4,7
+py_ewr-2.1.5.dist-info/RECORD,,