hspf 2.0.0__py3-none-any.whl

hspf/hspfModel.py

@@ -0,0 +1,203 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Thu Oct 13 09:26:05 2022
+
+@author: mfratki
+"""
+from pathlib import Path
+import os.path
+import subprocess
+
+from pyhspf.uci import UCI
+from pyhspf import hbn
+from pyhspf.reports import Reports
+from pyhspf.wdm import wdmInterface
+from pyhspf import wdmReader
+
+
+
+
+
+
+
+# Only for accessing information regarding a specific uci_file
+# Trying to segregate manipulating the uci file and information about the uci file
+
+
+class hspfModel():
+    winHSPF = str(Path(__file__).resolve().parent) + '\\bin\\WinHSPFLt\\WinHspfLt.exe'
+
+
+    # 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):
+                      #wdm_files:list = None,
+                      #hbn_files:str = None):
+        # Inputs
+        self.uci = UCI(uci_file)
+        self.hbn_paths= []
+        self.wdm_paths = []
+        self.uci_file = Path(uci_file).resolve()
+        # Validate and load binary data
+        self.validate_uci()
+        
+        
+        self.hbns = hbn.hbnInterface(self.hbn_paths)
+        try:
+            self.wdms = wdmInterface(self.wdm_paths)
+        except:
+            self.wdms = None
+        
+        # Compositions
+        self.reports = Reports(self.uci,self.hbns,self.wdms)
+        
+  
+    def validate_uci(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)
+            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()
+            else:
+                assert file_path.parent.exists(),'File folder Specified in the UCI does not exist: ' + file_path.as_posix()
+
+    def run_model(self,new_uci_file = None):
+        
+        if new_uci_file is None:
+            new_uci_file = self.uci_file
+        
+        # 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)
+
+    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):
+        self.uci = UCI(uci_file)
+        self.validate_uci()
+    
+    def convert_wdms(self):
+        for wdm_file in self.wdm_paths:
+            wdmReader.readWDM(wdm_file,
+                              wdm_file.parent.joinpath(wdm_file.name.replace('.wdm','.hdf5').replace('.WDM','hdf5')))
+        self._load_wdms()
+    
+    def load_wdm(self,wdm_file):
+        raise NotImplementedError()
+
+    def _load_wdms(self):
+        self.wdms = wdmInterface(self.wdm_paths)
+           
+    
+    # Model checks         
+    def check_filename_exist(self,file_extension: str):
+        table = self.uci.table('FILES',drop_comments = False)
+        uci_path = Path(self.uci_file).parent
+        check = []
+        for index, row in table.iterrows():
+            file_path = Path(row['FILENAME'])
+            if file_path.suffix == file_extension:
+                relative_path = (uci_path / file_path).resolve()
+                check.append(relative_path.exists())        
+        return all(check)
+            
+        
+        
+        
+    def check_filename_match(self,file_names):
+        table = self.uci.table('FILES',drop_comments = False)
+        #uci_path = Path(mod.uci.filepath).parent
+        for index, row in table.iterrows():
+            file_path = Path(row['FILENAME'])
+            if file_path.suffix == '.wdm':
+                assert(file_path.name in [file_name.name for file_name in file_names])
+    
+    def get_filename_paths(self,file_extension):
+        table = self.uci.table('FILES',drop_comments = False)
+        wdm_files = []
+        for index, row in table.iterrows():
+            file_path = Path(row['FILENAME'])
+            if file_path.suffix == file_extension:
+                wdm_files.append(self.uci_file.parent.joinpath(Path(file_path)))
+        return wdm_files    
+    
+    def update_filename_paths(self,file_names):
+        table = self.uci.table('FILES',drop_comments = False)
+        for index, row in table.iterrows():
+            file_path = Path(row['FILENAME'])
+            for file_name in file_names:
+                if file_name.name == file_path.name:  
+                    #print(Path(os.path.relpath(wdm_file, start = uci_path)).as_posix())
+                    table.loc[index,'FILENAME'] = Path(os.path.relpath(file_name, start = self.uci_file.parent)).as_posix()
+        self.uci.replace_table(table,'FILES')
+    
+    def check_filename_folder(self,file_extension):
+        table = self.uci.table('FILES',drop_comments = False)
+        for index, row in table.iterrows():
+            file_path = Path(row['FILENAME'])
+            if file_path.suffix == file_extension:  
+                if self.model_path.joinpath(file_path.parent).exists():
+                    continue
+                else:
+                    table.loc[index,'FILENAME'] = Path(os.path.relpath(file_path.name, start = self.uci_file.parent)).as_posix()
+        self.uci.replace_table(table,'FILES')
+
+
+
+
+
+
+# class runManager():
+#     def __init__()
+    
+#     self.requests = {'original': 0,'copy0':0,'copy1':0,'copy2':0}
+#     self.childs = {'original':None,
+#                 'copy0':None,
+#                 'copy1':None,
+#                 'copy2':None}
+    
+#     def original_run(self):
+#         table = self.table('FILES',drop_comments = False)
+#         # Assumes duplicate uci are in uci/copy/
+#         wdm_files = [ (index,name.split('/')[-1]) for index,name in enumerate(table['FILENAME'])
+#                  if name.split('.')[-1] in ['ech','out','wdm']]
+#         for file in wdm_files:
+#             table.iloc[file[0], table.columns.get_loc('FILENAME')] = '../wdms/' + file[1]
+    
+#         hbn_files =  [ (index,name.split('/')[-1]) for index,name in enumerate(table['FILENAME'])
+#                  if name.split('.')[-1] in ['hbn']]
+#         for file in hbn_files:
+#             table.iloc[file[0], table.columns.get_loc('FILENAME')] = '../hbns/' + file[1]
+        
+#         self.uci['FILES']['na']['table'][0] = table
+#         self.update_lines('FILES')
+        
+#     def duplicate_run(self,copy): #copy1,copy2,copy3 ... copy7 only options
+#         table = self.table('FILES',drop_comments = False)
+        
+#         # Assumes duplicate uci are in uci/copy/
+#         wdm_files = [ (index,name.split('/')[-1]) for index,name in enumerate(table['FILENAME'])
+#                  if name.split('.')[-1] in ['ech','out','wdm']]
+#         for file in wdm_files:
+#             table.iloc[file[0], table.columns.get_loc('FILENAME')] = '../../wdms/' + copy + '/' + file[1]
+    
+#         hbn_files =  [ (index,name.split('/')[-1]) for index,name in enumerate(table['FILENAME'])
+#                  if name.split('.')[-1] in ['hbn']]
+#         for file in hbn_files:
+#             table.iloc[file[0], table.columns.get_loc('FILENAME')] = '../../hbns/' + file[1]
+         
+#         self.uci['FILES']['na']['table'][0] = table
+#         self.update_lines('FILES')

hspf/parser/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Thu Dec  9 10:42:05 2021
+
+@author: mfratki
+"""