hspf 2.0.2__tar.gz → 2.1.0__tar.gz

{hspf-2.0.2 → hspf-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hspf
-Version: 2.0.2
+Version: 2.1.0
 Summary: Python package for downloading and running HSPF models
 Project-URL: Homepage, https://github.com/mfratkin1/pyHSPF
 Author-email: Mulu Fratkin <michael.fratkin@state.mn.us>

{hspf-2.0.2 → hspf-2.1.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "hspf"
 urls = { "Homepage" = "https://github.com/mfratkin1/pyHSPF" }  # ? Add this!
-version = "2.0.2"
+version = "2.1.0"
 dependencies = [
   "pandas",
   "requests",

{hspf-2.0.2 → hspf-2.1.0}/src/hspf/hbn.py

@@ -176,6 +176,12 @@ class hbnInterface:
     def get_multiple_timeseries(self,t_opn,t_code,t_con,opnids = None,activity = None,axis = 1):
         return pd.concat([hbn.get_multiple_timeseries(t_opn,t_code,t_con,opnids,activity) for hbn in self.hbns],axis = 1)
 
+    def get_perlnd_constituent(self,constituent,perlnd_ids = None,time_step = 5):
+        return get_simulated_perlnd_constituent(self,constituent,time_step)
+
+    def get_implnd_constituent(self,constituent,implnd_ids = None,time_step = 5):
+        return get_simulated_implnd_constituent(self,constituent,time_step)
+
     def get_reach_constituent(self,constituent,reach_ids,time_step,unit = None):
         if constituent == 'Q':
             df = get_simulated_flow(self,time_step,reach_ids,unit = unit)
@@ -209,48 +215,17 @@ class hbnInterface:
         
         return df
          
-         
+          
     def get_rchres_data(self,constituent,reach_ids,units = 'mg/l',t_code = 'daily'):
         '''
         Convience function for accessing the hbn time series associated with our current
         calibration method. Assumes you are summing across all dataframes.
-
-        Parameters
-        ----------
-        hbn : TYPE
-            DESCRIPTION.
-        nutrient_id : TYPE
-            DESCRIPTION.
-        reach_ids : TYPE
-            DESCRIPTION.
-        flux : TYPE, optional
-            DESCRIPTION. The default is None.
-
-        Returns
-        -------
-        df : TYPE
-            DESCRIPTION.
-
-        '''
-        
-        
+       '''
         
-        t_cons = helpers.get_tcons(constituent,'RCHRES',units)
-        
-
-        
-        df = pd.concat([self.get_multiple_timeseries(t_opn = 'RCHRES',
-                                     t_code =t_code,
-                                     t_con = t_con,
-                                     opnids = reach_ids)
-                         for t_con in t_cons],axis = 1).sum(1).to_frame()
-        
-        if (constituent == 'Q') & (units == 'cfs'):            
-            df = df/CF2CFS[t_code]*43560 #Acrfeet/invl to cubic feet/s
-            
+        df = pd.concat([self.get_reach_constituent(constituent,[reach_id],t_code,units) for reach_id in reach_ids], axis = 1)
+        df.columns = reach_ids
         df.attrs['unit'] = units
         df.attrs['constituent'] = constituent
-        df.attrs['reach_ids'] = reach_ids
         return df
     
         

{hspf-2.0.2 → hspf-2.1.0}/src/hspf/hspfModel.py

@@ -30,7 +30,7 @@ class hspfModel():
 
     # Imposed structures of an hspf model:
         # 1. all model files are located in the same directory as the uci file.
-    def __init__(self,uci_file:str):
+    def __init__(self,uci_file:str,run_model:bool = False):
                       #wdm_files:list = None,
                       #hbn_files:str = None):
         # Inputs
@@ -39,7 +39,7 @@ class hspfModel():
         self.wdm_paths = []
         self.uci_file = Path(uci_file).resolve()
         # Validate and load binary data
-        self.validate_uci()
+        self.validate_uci(run_model = run_model)
         
         
         self.hbns = hbn.hbnInterface(self.hbn_paths)
@@ -51,8 +51,28 @@ class hspfModel():
         # Compositions
         self.reports = Reports(self.uci,self.hbns,self.wdms)
         
+
+    def validate_wdms(self):
+        # Ensure wdm files exist and the folders for the other file types exist relative
+        # to the uci path   
+
+        for index, row in self.uci.table('FILES',drop_comments = False).iterrows():
+            file_path = self.uci_file.parent.joinpath(Path(row['FILENAME']))            
+            if file_path.suffix.lower() == '.wdm':
+                assert file_path.exists(),'File Specified in the UCI does not exist:' + file_path.as_posix()
+                self.wdm_paths.append(file_path)
   
-    def validate_uci(self):
+    def validate_pltgens(self):
+        raise NotImplementedError() 
+
+    def validate_folders(self):
+        for index, row in self.uci.table('FILES',drop_comments = False).iterrows():
+            file_path = self.uci_file.parent.joinpath(Path(row['FILENAME']))            
+            assert file_path.parent.exists(),'File folder Specified in the UCI does not exist: ' + file_path.as_posix()
+
+
+ 
+    def validate_uci(self,run_model:bool = False):
         # Ensure wdm files exist and the folders for the other file types exist relative
         # to the uci path   
 
@@ -63,15 +83,15 @@ class hspfModel():
                 self.wdm_paths.append(file_path)
             elif file_path.suffix.lower() == '.hbn':
                 assert file_path.parent.exists(),'File folder Specified in the UCI does not exist: ' + file_path.as_posix()
-                #self.hbns[file_path.name.split('.')[0]] = None
-                if file_path.exists():
-                    #self.hbns[file_path.name.split('.')[0]] = hbn.hbnClass(file_path)
-                    self.hbn_paths.append(file_path)
-                else:
-                    self.run_model()
+                self.hbn_paths.append(file_path)
             else:
                 assert file_path.parent.exists(),'File folder Specified in the UCI does not exist: ' + file_path.as_posix()
 
+        if (all(file_path.exists() for file_path in self.hbn_paths)) & (run_model == False):
+            pass
+        else:
+            self.run_model()
+
     def run_model(self,new_uci_file = None):
         
         if new_uci_file is None:
@@ -80,14 +100,14 @@ class hspfModel():
         # new_uci_file = self.model_path.joinpath(uci_name)
         # self.uci.write(new_uci_file)
         subprocess.run([self.winHSPF,self.uci_file.as_posix()]) #, stdout=subprocess.PIPE, creationflags=0x08000000)
-        self.load_uci(new_uci_file)
+        self.load_uci(new_uci_file,run_model = False)
 
     def load_hbn(self,hbn_name):
         self.hbns[hbn_name] = hbn.hbnClass(self.uci_file.parent.joinpath(hbn_name).as_posix())
 
-    def load_uci(self,uci_file):
+    def load_uci(self,uci_file,run_model:bool = False):
         self.uci = UCI(uci_file)
-        self.validate_uci()
+        self.validate_uci(run_model = run_model)
     
     def convert_wdms(self):
         for wdm_file in self.wdm_paths: