pyhcal 1.1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

pyhcal/ERROR.FIL

@@ -0,0 +1,78 @@
+16:15:00.416 : LOG_MSG:ERROR.FIL OPENED
+16:15:00.417 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+16:15:00.417 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+18:06:13.144 : LOG_MSG:ERROR.FIL OPENED
+18:06:13.145 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+18:06:13.145 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+18:09:53.704 : LOG_MSG:ERROR.FIL OPENED
+18:09:53.705 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+18:09:53.705 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+18:19:02.896 : LOG_MSG:ERROR.FIL OPENED
+18:19:02.896 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+18:19:02.896 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+18:19:05.790 : LOG_MSG:ERROR.FIL OPENED
+18:19:05.790 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+18:19:05.790 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+18:32:46.775 : LOG_MSG:ERROR.FIL OPENED
+18:32:46.776 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+18:32:46.776 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+18:38:43.431 : LOG_MSG:ERROR.FIL OPENED
+18:38:43.432 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+18:38:43.432 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+18:44:23.798 : LOG_MSG:ERROR.FIL OPENED
+18:44:23.799 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+18:44:23.800 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+18:52:12.607 : LOG_MSG:ERROR.FIL OPENED
+18:52:12.608 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+18:52:12.608 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+18:59:18.608 : LOG_MSG:ERROR.FIL OPENED
+18:59:18.609 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+18:59:18.609 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+19:05:51.046 : LOG_MSG:ERROR.FIL OPENED
+19:05:51.047 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+19:05:51.047 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+19:14:05.088 : LOG_MSG:ERROR.FIL OPENED
+19:14:05.088 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+19:14:05.089 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0
+19:18:33.712 : LOG_MSG:ERROR.FIL OPENED
+19:18:33.713 : HASS_ENT:F90_WDBOPNR:entr:WDMSFL,RWFLG:         100           1 C:\Users\mfratki\Documents\github\pyHSPF\src\hspf\bin\WinHSPFLt\hspfmsg.wdm
+19:18:33.713 : HASS_ENT:F90_WDBOPNR:exit:WDMSFL,RETCOD         100           0
+FILBLK RETCOD           0
+wdmfl           0           0           0           0
+FILBLK RETCOD           0

pyhcal/calibrators.py

@@ -10,6 +10,7 @@ import subprocess
 #non-standard imports
 import pandas as pd
 import numpy as np
+import geopandas as gpd
 from pathlib import Path
 
 #My packages
@@ -20,7 +21,7 @@ from mpcaHydro import data_manager as dm
 from pyhcal import metrics
 from pyhcal import figures
 from pyhcal import setup_utils
-
+from pyhcal.mappers import Mapper
 
 def new_calibration(project_folder,model_name,download_station_data = True,run_model = True,convert_wdms = True):
     return setup_utils.create_calibration_project(model_name,project_folder,download_station_data,run_model,convert_wdms)
@@ -45,6 +46,7 @@ class calibrator:
         self.project_name = self.project_path.name
         self.model_path = self.project_path.joinpath('model')
         self.output_path = self.project_path.joinpath('output')
+        self.gis_path = self.project_path.joinpath('gis')
         self.run = None
         self.start_date = '1996-01-01'
         self.end_date = '2100-01-01'
@@ -58,25 +60,48 @@ class calibrator:
               
         self.MODL_DB = pd.read_csv(self.project_path.joinpath('_'.join([self.project_name ,'MODL_DB.csv'])))
         
+        # Alot of effort to try and include the subwatershed gdf if it exists. TODO: refactor
+        self.subwatershed_gdf_filepath = self.gis_path.joinpath('_'.join([self.project_name ,'Subwatersheds.shp']))
+        if self.subwatershed_gdf_filepath.exists():
+            self.subwatershed_gdf = gpd.read_file(self.subwatershed_gdf_filepath)
+            if 'SubID' in self.subwatershed_gdf.columns:
+                self.subwatershed_gdf = self.subwatershed_gdf.set_index('SubID')
+            else:
+                print("Warning: 'SubID' column not found in subwatershed shapefile. GIS operations will not function correctly.")
+        else:
+            self.subwatershed_gdf = None
+        
         self.model = None
         self._wdms = None
         self.uci = None
-        
+        self.mapper = None
     ## Input/Output methods
+
+
     def initialize(self,reach_ids,default = 4):
 
         self.uci.update_table(default,'RCHRES','BINARY-INFO',0,columns = ['HEATPR','HYDRPR','SEDPR','OXRXPR','NUTRPR','PLNKPR'],operator = 'set')
         self.uci.update_table(2,'RCHRES','BINARY-INFO',0,columns = ['HEATPR','HYDRPR','SEDPR','OXRXPR','NUTRPR','PLNKPR'],opnids = reach_ids,operator = 'set')
         
         self.uci.write(self.model.uci_file)
-        winHSPF = str(Path(__file__).resolve().parent.parent) + '\\bin\\WinHSPFLt\\WinHspfLt.exe'     
-        subprocess.run([winHSPF,self.model.uci_file]) #, stdout=subprocess.PIPE, creationflags=0x08000000)
+        subprocess.run([self.model.winHSPF,self.model.uci_file]) #, stdout=subprocess.PIPE, creationflags=0x08000000)
         
     def set_dates(self, start_date = '1996-01-01',end_date ='2100-01-01'):
         self.start_date = start_date
         self.end_date = end_date
 
-        
+    def _load_gdf(self,catchment_id_column = 'SubID'):
+        self.subwatershed_gdf_filepath = self.gis_path.joinpath('_'.join([self.project_name ,'Subwatersheds.shp']))
+        if self.subwatershed_gdf_filepath.exists():
+            self.subwatershed_gdf = gpd.read_file(self.subwatershed_gdf_filepath)
+            self.subwatershed_gdf = self.subwatershed_gdf.set_index(catchment_id_column)
+        else:
+            self.subwatershed_gdf = None
+
+    def _update_mapper(self):
+        if self.subwatershed_gdf is not None:
+            self.mapper = Mapper(self.project_name,self.uci,self.subwatershed_gdf,hbn = self.model.hbns)
+
     def load_model(self,name):
 
         if isinstance(name,int): # Default approach
@@ -98,8 +123,10 @@ class calibrator:
                 
         self.model.wdms = self._wdms
         self.model.reports.wdms = self._wdms
-        self.uci = deepcopy(self.model.uci) #uci to be manipulated 
+        self.uci = deepcopy(self.model.uci) #uci to be manipulated
 
+        if self.subwatershed_gdf is not None:
+            self.mapper = Mapper(self.project_name,self.uci,self.subwatershed_gdf,hbn = self.model.hbns)
 
     def run_model(self,name = None,overwrite_hbn = False): # NO STATE CHANGE 
         
@@ -125,7 +152,7 @@ class calibrator:
         return sim
     
     def get_observed_data(self,station_ids,constituent,time_step = 'YE',baseflow_percentage = None):
-        obs = self.dm._get_data(station_ids,constituent,agg_period = time_step).sort_index(level = 'index')
+        obs = self.dm.get_station_data(station_ids,constituent,agg_period = time_step)['observed'].sort_index(level = 'index')
         obs.name = 'observed'
         return obs
      

pyhcal/mappers.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Mon Jan 27 11:20:47 2025
+
+@author: mfratki
+"""
+
+from pyhcal.repository import Repository
+from hspf.uci import UCI
+import geopandas as gpd
+import matplotlib.pyplot as plt
+import pandas as pd
+from pathlib import Path
+
+# Try to load statewide subwatersheds from data folder,
+
+# try:
+#     SUBWATERSHEDS = gpd.read_file(str(Path(__file__).resolve().parent/'data\\statewide_subwatersheds.gpkg'))
+# except:
+#     print("Could not load statewide subwatersheds. Please ensure the file 'statewide_subwatersheds.gpkg' is located in the 'data' folder of the pyhcal package.")
+    
+
+
+class uciMapper():
+    def __init__(self,model_names,gis_layer,huc6 = False):
+        self.mappers = []
+        
+        if huc6:
+            model_names = Repository.HUC_DIRECTORY.loc[Repository.HUC_DIRECTORY['Repository_HUC6 Name'].isin(model_names),'Repository_HUC8 Name']
+            model_names = model_names.loc[model_names.isin(Repository.valid_models())].values
+    
+        for model_name in model_names:
+            repo = Repository(model_name)
+            uci = UCI(repo.uci_file)
+            #gis_layer = SUBWATERSHEDS.loc[SUBWATERSHEDS['repo_name'] == model_name,:]
+            #gis_layer.set_index('SubID',inplace=True)
+            self.mappers.append(Mapper(model_name,uci,gis_layer))
+    
+    def map_parameter(self,operation,table_name,parameter,table_id):
+        table = self.join_table(operation,table_name,table_id)
+        fig, ax = plt.subplots()
+        #[table.plot(column = parameter,ax = ax) for table in tables]
+        table.plot(column = parameter,ax = ax,cmap='viridis',legend=True)
+        plt.title(parameter)
+    
+    def join_table(self,operation,table_name,table_id):
+        tables = [mapper.join_table(operation,table_name,table_id) for mapper in self.mappers]
+        table = pd.concat(tables)
+        return table
+    
+class Mapper():
+    def __init__(self,model_name,uci,subwatershed_gdf,hbn = None):
+        self.model_name = model_name
+        self.uci = uci
+        self.hbn = hbn
+        # if subwatershed_gdf is None:
+        #     subwatershed_gdf = SUBWATERSHEDS.loc[SUBWATERSHEDS['repo_name'] == model_name,:]
+        #     subwatershed_gdf.set_index('SubID',inplace=True)
+        
+        self.subwatershed_gdf = subwatershed_gdf
+        self.subwatersheds = uci.network.subwatersheds()
+        self.subwatershed_ids = list(set(self.subwatersheds.index))
+
+    def map_parameter(self,operation,table_name,parameter,table_id=0,weight_by_area = True):
+        fig, ax = plt.subplots()
+        self.join_table(operation,table_name,parameter,table_id).plot(column = parameter,ax = ax,cmap='viridis',legend=True)
+        plt.title(parameter)
+        
+    def join_table(self,operation,table_name,parameter,table_id=0,weight_by_area = True):
+        table = self.uci.table(operation,table_name,table_id)
+        subwatersheds = self.uci.network.subwatersheds()
+        subwatersheds = subwatersheds.loc[subwatersheds['SVOL'] == 'PERLND'].reset_index(drop=False).set_index('SVOLNO').join(table,how = 'left')
+        subwatersheds.index.name = 'SVOLNO' # Sometimes the index name gets dropped. I'm guessing when there are missing joins.
+        subwatersheds = subwatersheds.reset_index('SVOLNO').set_index(['SVOLNO','TVOLNO','SVOL','MLNO'])
+        
+        #weight by area factor:
+        if weight_by_area:
+            subwatersheds['weighted_param'] = subwatersheds['AFACTR']*subwatersheds[parameter]
+            subwatersheds = subwatersheds.groupby(subwatersheds.index.get_level_values('TVOLNO'))['weighted_param'].sum()/subwatersheds.groupby(subwatersheds.index.get_level_values('TVOLNO'))['AFACTR'].sum()
+            subwatersheds.name = parameter
+        else:
+            subwatersheds = subwatersheds.groupby(subwatersheds.index.get_level_values('TVOLNO'))[parameter].mean()
+            subwatersheds.name = parameter
+        return self.subwatershed_gdf.join(subwatersheds)
+ 
+    def map_flag():
+        raise NotImplementedError()
+        
+    def map_output(self,operation,output_name,t_code=5,agg_func = 'mean'):
+        subwatersheds = self.subwatersheds.loc[(self.subwatersheds['SVOL'] == operation),:].copy()
+        opnids = list(subwatersheds['SVOLNO'].unique())
+        output = self.hbn.get_multiple_timeseries(operation,t_code,output_name,opnids = opnids).agg(agg_func)
+        if operation in ['PERLND','IMPLND']:
+            subwatersheds = pd.merge(subwatersheds,output.to_frame(output_name),right_index = True,left_on = 'SVOLNO')
+            subwatersheds['area_output'] = subwatersheds['AFACTR']*subwatersheds[output_name]
+            subwatersheds = subwatersheds[['AFACTR','area_output']].groupby(subwatersheds.index).sum()
+            subwatersheds[output_name] = subwatersheds['area_output']/subwatersheds['AFACTR']
+        
+        fig, ax = plt.subplots()
+        #[table.plot(column = parameter,ax = ax) for table in tables]
+        self.subwatershed_gdf.join(subwatersheds).plot(column = output_name,ax = ax,cmap='viridis',legend=True)
+        plt.title(output_name)
+    
+        #return self.subwatershed_gdf.join(subwatersheds)
+

{pyhcal-1.1.0.dist-info → pyhcal-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyhcal
-Version: 1.1.0
+Version: 1.1.1
 Summary: Python package for calibrating MPCA HSPF models
 Project-URL: Homepage, https://github.com/mfratkin1/pyhcal
 Author-email: Mulu Fratkin <michael.fratkin@state.mn.us>

{pyhcal-1.1.0.dist-info → pyhcal-1.1.1.dist-info}/RECORD

@@ -1,15 +1,14 @@
+pyhcal/ERROR.FIL,sha256=w35iHJYKYpcU9lrmU4FqLGMlKLabOOX-_Z567kHF8CA,5018
 pyhcal/__init__.py,sha256=4TEpGD-PfEY8yK-od8DpEMA4_iQ-q9y0PBvROXSPdB0,94
-pyhcal/calibrators.py,sha256=lDxvXpjLj1Xhp-NPCVUyyWeaMTZdP5FA9Bh-PuwrOHs,30383
+pyhcal/calibrators.py,sha256=jWlM7-eWLLDpgASzLpEQQ6jUBx9T9vDaUMeMaF-GWzk,31939
 pyhcal/figures.py,sha256=Iu7LaN_i2IuDA_nfxj-a8AkG-FTLZVicJ3-efIs5OiE,45534
+pyhcal/mappers.py,sha256=YhrYbX8H5rvWFFXBS2a8UAaEFIwZQwE4Vzxz1TIN97Q,5225
 pyhcal/metrics.py,sha256=GUGHd-op-g1Foj8wnS_JVURSms4ifcC0a5h8ketQ29I,17911
 pyhcal/modl_db.py,sha256=z8trT387Gcbg15xAqAcW62c1dbgSSjymv3qOyH3Dyx8,12569
 pyhcal/repository.py,sha256=VPHeSbrnFAG1F6tFXdnI2C72xm3dTPb7Z3rkPr--srI,4603
 pyhcal/setup_utils.py,sha256=sIINj8_h-MgQhcCH_u95nFTJVw0QEgnR0fZgAitX1iQ,30398
 pyhcal/data/HUC_Names.csv,sha256=UGmd3Q5E8DyFWggXzaXWpsRze7sFyrlpYqaYpMWAiGM,18946
 pyhcal/data/WISKI_EQUIS_XREF.csv,sha256=bPYq-f4-Qc6jsvUgl81lwXBeFamfDe5TjohqUV1XJlg,1244704
-pyhcal/data/outlets.duckdb,sha256=zB1t2NsnrUed-3HOT61DYmtOy89PZ9uWZAwmAEUhleY,2895872
-pyhcal/data/stations_EQUIS.gpkg,sha256=SPyxGK5H3bbqMikv45n_ul-KULPNWyad9XcDq_9mXwM,2019328
-pyhcal/data/stations_wiski.gpkg,sha256=vlh03SihjlQMIbn25rfPqOKQtJsSYS2FMR65zAznTQQ,905216
-pyhcal-1.1.0.dist-info/METADATA,sha256=xRX7vV5LA1UxSsAZze6VMRzTJI6ePZ749Pdf8h-VQgw,560
-pyhcal-1.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-pyhcal-1.1.0.dist-info/RECORD,,
+pyhcal-1.1.1.dist-info/METADATA,sha256=ishvd0JOT5YuSTJvsjWvpKnM6Bxll2tc0-iyLk3aUd8,560
+pyhcal-1.1.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+pyhcal-1.1.1.dist-info/RECORD,,