wrfhydropy.Domain

class wrfhydropy.Domain(domain_top_dir: str, domain_config: str, compatible_version: str = None, hydro_namelist_patch_file: str = 'hydro_namelist_patches.json', hrldas_namelist_patch_file: str = 'hrldas_namelist_patches.json')

Class for a WRF-Hydro domain, which constitutes all domain-specific files needed for a setup.

Methods

copy_files(self, dest_dir, symlink)

Copy domain files to a new directory :Parameters: * dir – The destination directory for domain files * symlink – Symlink domain files instead of copy

__init__(self, domain_top_dir:str, domain_config:str, compatible_version:str=None, hydro_namelist_patch_file:str='hydro_namelist_patches.json', hrldas_namelist_patch_file:str='hrldas_namelist_patches.json')

Instantiate a Domain object :Parameters: * domain_top_dir – Parent directory containing all domain directories and files.

• domain_config – The domain configuration to use, options are ‘NWM’, ‘Gridded’, or ‘Reach’
• compatible_version – String indicating the compatible model version, required if no
• .version file included in domain_top_dir.
• hydro_namelist_patch_file – Filename of json file containing namelist patches for
• hydro namelist
• hrldas_namelist_patch_file – Filename of json file containing namelist patches for
• hrldas namelist

Methods

__init__(self, domain_top_dir, …)	Instantiate a Domain object :Parameters: * domain_top_dir – Parent directory containing all domain directories and files.
copy_files(self, dest_dir, symlink)	Copy domain files to a new directory :Parameters: * dir – The destination directory for domain files * symlink – Symlink domain files instead of copy