runrs.py

'''
Functions for running RICorDE workflows
'''
import os

 
 
from definitions import proj_dir
from hp.basic import get_dict_str
import configparser
from ricorde.scripts import config_params

def print_parser(parser):
    for sectName, sect in parser.items():
 
        for varName, var in sect.items():
            print(sectName, varName, var)
    

def get_parser(fp):
    assert os.path.exists(fp), fp
    
    parser=configparser.ConfigParser(inline_comment_prefixes='#')
    parser.optionxform =str #make case sensitive
    parser.read(fp)
    
    #print_parser(parser)
    
    return parser

def load_params(param_fp,
                config_params=config_params,
                ):
    """
    Load RICorDE run parameters from a config file
    
    Parametersd
    ----------
    param_fp : str
        Filepath to parameter file
    config_params : dict, default Session.config_params
        parameters for the configarser {sectionName:{varName:(mandatory_flag, ConfigParser get method)}}
        defaults to Session
 
 
    """
    
    #===========================================================================
    # init the parser
    #===========================================================================
    

    parser = get_parser(param_fp)
    #===========================================================================
    # check parameter file
    #===========================================================================
    for sectName, sect in parser.items():
        if sectName =='DEFAULT': 
            continue
        assert sectName in config_params, 'got unrecognized section name \'%s\''%sectName
        for varName, var in sect.items():
            assert varName in config_params[sectName], 'got unrecognized variable: \'%s.%s\' from %s'%(
                sectName, varName, os.path.basename(param_fp))
            #print('%s.%s'%(sectName, varName))
    
    #===========================================================================
    # load usin the parameters
    #===========================================================================
    cnt = 0
    res_lib = {k:dict() for k in config_params.keys()}  #results congainer
    for sectName, d in config_params.items():
        assert sectName in parser.sections(), '%s missing from parameter file'%sectName
        for varName, (required, method) in d.items():
            #print('%s.%s: required=%s, method=%s'%(sectName, varName, required, method))
            
            #check if the parameter is in the file
            if varName in parser[sectName]:
                f = getattr(parser, method)
                try:
                    val = f(sectName, varName)
                except Exception as e:
                    raise IOError('failed to get %s.%s w/ \n    %s'%(sectName, varName, e))
                    
                if val in ['']:
                    assert not required, '%s.%s is required but was passed empty'%(sectName, varName)
                else:
                    res_lib[sectName][varName] = val
 
                    
                cnt+=1
            else:
                assert not required, '%s.%s is required and not found in the parameter file'%(sectName, varName)
            
    print('retrieved %i parameters from file\n%s'%(cnt, get_dict_str(res_lib)))
    
    return res_lib


def run_from_params(
                #parameter inputs and file
                param_fp=os.path.join(proj_dir, 'params_default.txt'),
                param_lib=None,
                
                **kwargs):
    """execute a RICorDE workflow from a parameter file
    
    Parameters
    ----------
    param_fp : str
        Filepath to parameter file. Defaults to the params_default.txt found in the project
    param_lib : dict, optional
        Override loading from file and use the passed parameters (mainly for testing)
        
    Returns
    ----------
    str
        Directory where outputs are written
    dict
        Keyed output filepaths
        
    Notes
    -----------
    parameters passed in the 'session' section will be passed as kwargs to the  __init__ cascade.
    Other sections will be passed in 'bk_lib'
    
    """
    #===========================================================================
    # #load from teh parameter file
    #===========================================================================
    if param_lib is None:
        param_lib = load_params(param_fp)
    
    #extract special parameters
    d = param_lib.pop('session')
    session_kwargs = {k:v for k,v in d.items() if not v==''} #clear empties
    print('running w/ \n%s\n\n'%get_dict_str(session_kwargs))
    
    #===========================================================================
    # prerun checks
    #===========================================================================
    for k,v in session_kwargs.items():
        if k.endswith('_fp'):
            assert os.path.exists(v), 'passed bad filepath for \'%s\':\n    \'%s\''%(
                k, v)

    #===========================================================================
    # #initilze the calculation session using these parameters
    #===========================================================================
    from ricorde.scripts import Session
    with Session(                  
            bk_lib = param_lib,
            **{**session_kwargs, **kwargs}
            ) as wrkr:

        wrkr.logger.info('\n\n start calc sequence\n\n')
        wrkr.run_dataPrep() #Clean and load inputs into memory.
        wrkr.run_HAND() #Build the HAND raster from the DEM using whiteboxtools
        wrkr.run_imax() #Perform the Phase 1: Inundation Correction
        wrkr.run_HANDgrid() #Perform PHASE2: Compute Rolling HAND grid
        wrkr.run_wslRoll() #Perform PHASE3: Rolling WSL grid
        wrkr.run_depths() #PHASE4: Resultant Depths computation
        
        outputs = wrkr.out_dir, wrkr.ofp_d
        
    return outputs