wrfhydropy.Domain

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

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

Methods

copy_files(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__(domain_top_dir: str, domain_config: str, compatible_version: str | None = None, hydro_namelist_patch_file: str = 'hydro_namelist_patches.json', hrldas_namelist_patch_file: str = 'hrldas_namelist_patches.json')[source]

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__(domain_top_dir, domain_config[, ...])

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.

copy_files(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

Attributes

domain_top_dir

pathlib.Paths to *.TBL files generated at compile-time.

domain_config

Specified configuration for which the domain is to be used, e.g. 'NWM_ana'.

compatible_version

Source-code version for which the domain is to be used.

hydro_namelist_patches

Domain-specific hydro namelist settings.

hrldas_namelist_patches

Domain-specific hrldas namelist settings.

hydro_files

Files specified in hydro_nlist section of the domain namelist patches

nudging_files

Files specified in nudging_nlist section of the domain namelist patches

lsm_files

Files specified in noahlsm_offline section of the domain namelist patches

nudging_dir

path to the nudging obs directory

forcing_dir

path to the forcing directory