HmsGage¶
Time-series gage operations for HEC-HMS.
hms_commander.HmsGage
¶
HmsGage - Time-Series Gage File Operations
This module provides static methods for reading and modifying HEC-HMS time-series gage files (.gage). It handles precipitation gages, discharge gages, and their DSS data references.
All methods are static and designed to be used without instantiation.
HmsGage
¶
Time-series gage file operations (.gage files).
Manage gage data and DSS references for precipitation, discharge, and other time-series data.
All methods are static - no instantiation required.
Example
from hms_commander import HmsGage gages = HmsGage.get_gages("model.gage") print(gages)
Source code in hms_commander/HmsGage.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 | |
get_gages(gage_path=None, hms_object=None)
staticmethod
¶
Get all gages from a gage file or HMS project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gage_path
|
Union[str, Path]
|
Path to the .gage file (optional if hms_object provided) |
None
|
hms_object
|
HmsPrj instance (uses global hms if None) |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with columns: name, type, units, dss_file, dss_pathname |
Example
gages = HmsGage.get_gages("model.gage") print(gages[['name', 'type', 'units']])
Source code in hms_commander/HmsGage.py
get_gage_info(gage_name, gage_path=None, hms_object=None)
staticmethod
¶
Get detailed information for a specific gage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gage_name
|
str
|
Name of the gage |
required |
gage_path
|
Union[str, Path]
|
Path to the .gage file |
None
|
hms_object
|
Optional HmsPrj instance |
None
|
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dictionary with all gage parameters |
Example
info = HmsGage.get_gage_info("Precip-Gage-1", "model.gage") print(f"DSS File: {info['dss_file']}")
Source code in hms_commander/HmsGage.py
get_dss_pathname(gage_name, gage_path=None, hms_object=None)
staticmethod
¶
Get the DSS pathname for a specific gage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gage_name
|
str
|
Name of the gage |
required |
gage_path
|
Union[str, Path]
|
Path to the .gage file |
None
|
hms_object
|
Optional HmsPrj instance |
None
|
Returns:
| Type | Description |
|---|---|
str
|
DSS pathname string |
Example
pathname = HmsGage.get_dss_pathname("Precip-Gage-1", "model.gage")
Source code in hms_commander/HmsGage.py
create_gage(gage_path, name, dss_file, pathname, gage_type='Precipitation', units='IN', data_type='PER-CUM', description='', hms_object=None)
staticmethod
¶
Create a new gage entry in a gage file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gage_path
|
Union[str, Path]
|
Path to the .gage file |
required |
name
|
str
|
Name for the new gage |
required |
dss_file
|
Union[str, Path]
|
Path to the DSS file |
required |
pathname
|
str
|
DSS pathname for the data |
required |
gage_type
|
str
|
Type of gage (Precipitation, Discharge, etc.) |
'Precipitation'
|
units
|
str
|
Data units (IN, MM, CFS, etc.) |
'IN'
|
data_type
|
str
|
DSS data type (PER-CUM, INST-VAL, etc.) |
'PER-CUM'
|
description
|
str
|
Optional description |
''
|
hms_object
|
Optional HmsPrj instance |
None
|
Returns:
| Type | Description |
|---|---|
bool
|
True if successful |
Example
HmsGage.create_gage( ... "model.gage", ... name="New-Gage", ... dss_file="precip.dss", ... pathname="/BASIN/GAGE1/PRECIP-INC//15MIN/OBS/", ... gage_type="Precipitation", ... units="IN" ... )
Source code in hms_commander/HmsGage.py
update_gage(gage_path, gage_name, dss_file=None, pathname=None, units=None, hms_object=None)
staticmethod
¶
Update an existing gage entry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gage_path
|
Union[str, Path]
|
Path to the .gage file |
required |
gage_name
|
str
|
Name of the gage to update |
required |
dss_file
|
str
|
New DSS file path (optional) |
None
|
pathname
|
str
|
New DSS pathname (optional) |
None
|
units
|
str
|
New units (optional) |
None
|
hms_object
|
Optional HmsPrj instance |
None
|
Returns:
| Type | Description |
|---|---|
bool
|
True if successful |
Source code in hms_commander/HmsGage.py
delete_gage(gage_path, gage_name, hms_object=None)
staticmethod
¶
Delete a gage entry from a gage file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gage_path
|
Union[str, Path]
|
Path to the .gage file |
required |
gage_name
|
str
|
Name of the gage to delete |
required |
hms_object
|
Optional HmsPrj instance |
None
|
Returns:
| Type | Description |
|---|---|
bool
|
True if successful |
Source code in hms_commander/HmsGage.py
list_precip_gages(gage_path=None, hms_object=None)
staticmethod
¶
Get a list of precipitation gage names.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gage_path
|
Union[str, Path]
|
Path to the .gage file |
None
|
hms_object
|
Optional HmsPrj instance |
None
|
Returns:
| Type | Description |
|---|---|
List[str]
|
List of precipitation gage names |
Source code in hms_commander/HmsGage.py
list_discharge_gages(gage_path=None, hms_object=None)
staticmethod
¶
Get a list of discharge gage names.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gage_path
|
Union[str, Path]
|
Path to the .gage file |
None
|
hms_object
|
Optional HmsPrj instance |
None
|
Returns:
| Type | Description |
|---|---|
List[str]
|
List of discharge gage names |
Source code in hms_commander/HmsGage.py
get_dss_files(gage_path=None, hms_object=None)
staticmethod
¶
Get a list of unique DSS files referenced by gages.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gage_path
|
Union[str, Path]
|
Path to the .gage file |
None
|
hms_object
|
Optional HmsPrj instance |
None
|
Returns:
| Type | Description |
|---|---|
List[str]
|
List of unique DSS file paths |