HmsDssGrid¶
DSS grid writing for gridded precipitation workflows, and the engine's gridded import and grid tools. Example notebooks: 14a (SHG route) and 23 (import, grid tools, zonal statistics).
hms_commander.HmsDssGrid
¶
Static class for DSS grid operations using HEC Monolith.
Provides methods for writing gridded precipitation data to DSS format, mirroring the implementation pattern found in HEC-Vortex.
All methods are static - do not instantiate this class.
Engine tools
import_gridded, import_arrays, import_zarr, list_variables,
zarr_variables, read_zarr, calculate, calculate_raster,
sanitize, clip, normalize, shift_times, resample_times,
time_steps, series_info, read_window, read_nearest,
read_min_max, grid_to_point, zonal_statistics and zone_masks
are thin wrappers around the functions of the same names in
ras_commander_fast_dss.gridded. They run on the optional
ras-commander-fast-dss engine whatever HmsDss.backend is (there is no
Java route), pass their remaining arguments to the engine unchanged and
return its result unchanged. They raise ImportError without the engine
and DssCapabilityError when the installed version does not provide the
operation; get_features() reports what it provides.
help(ras_commander_fast_dss.gridded.<name>) documents every option.
sync:
The engine's flush policy on the methods that write, passed through
unchanged. None (default) states nothing, so the installed engine's own
default applies; that default can change between engine releases. In
ras-commander-fast-dss 0.1.2 the modes are "end" (default; True),
"step" and "none" (False); a call that stores several records
flushes once, after its last record, under "end".
Threads
In ras-commander-fast-dss 0.1.2, import_gridded, import_arrays and
import_zarr use every core by default (threads=None). The records
(cell values, grid metadata and pathnames) do not depend on the count, but
the file bytes can differ, because DSS stores each record's write time.
Pass threads=1 to limit it.
Technical Background
HMS requires gridded precipitation data in DSS format with specific grid metadata (SpecifiedGridInfo for WGS84). This class uses the same HEC Monolith Java classes as HEC-Vortex, accessed via pyjnius.
Example
from hms_commander import HmsDssGrid import numpy as np
Write AORC data to DSS¶
HmsDssGrid.write_grid_timeseries( ... dss_file="aorc.dss", ... pathname="/AORC/STORM/PRECIP////", ... grid_data=precip_array, ... lat_coords=lat_array, ... lon_coords=lon_array, ... timestamps=time_list ... )
Source code in hms_commander/dss/hms_dss_grid.py
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 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 | |
write_grid_timeseries(dss_file, pathname, grid_data, lat_coords, lon_coords, timestamps, units='MM', data_type='PER-CUM', interval_minutes=None, *, target_crs=None, cell_size=None, resample_method='bilinear', envelope=None, sync=None)
staticmethod
¶
Write gridded precipitation time series to DSS file.
Converts NumPy grid arrays to DSS grid format using HEC Monolith, following the pattern from HEC-Vortex's DssDataWriter.
Parameters¶
dss_file : str or Path
Output DSS file path. Created if it doesn't exist.
pathname : str
DSS pathname for the grid data.
Format: /A/B/C/D/E/F/ where typically:
- A: Source identifier (e.g., "AORC")
- B: Location/grid name
- C: Parameter (e.g., "PRECIP")
- D-F: Time/version (handled internally)
grid_data : np.ndarray
Precipitation data as 3D array with shape (time, lat, lon).
Values should be in units specified by units parameter.
lat_coords : np.ndarray
1D array of latitude values in decimal degrees (WGS84).
Must match grid_data.shape[1].
lon_coords : np.ndarray
1D array of longitude values in decimal degrees (WGS84).
Must match grid_data.shape[2].
timestamps : List[datetime]
Times of the grids. For INST-VAL and INST-CUM: one instant per grid.
For PER-CUM and PER-AVER: one period end per grid (the period is
the interval_minutes before it), or one more time than there are grids,
as period boundaries. AORC stamps are period ends, so they pass unchanged.
Times must be whole minutes, and naive or UTC. A UTC time is stored at its
UTC clock time; another time zone raises ValueError, because DSS grid
times hold no zone and the model clock is the caller's choice.
units : str, default "MM"
Data units string. Common values:
- "MM" - millimeters
- "IN" - inches
data_type : str, default "PER-CUM"
DSS data type. Options:
- "PER-CUM" - Period cumulative (for precipitation)
- "PER-AVER" - Period average (for temperature)
- "INST-VAL" - Instantaneous value
- "INST-CUM" - Instantaneous cumulative
interval_minutes : int, optional
Period length for PER-CUM and PER-AVER when timestamps holds
period ends. None: the spacing of the timestamps, which must be uniform.
A single grid or stamps with gaps need this argument. Not used for
instantaneous data.
target_crs : str, optional
None (default): write the WGS 84 grid as given, through the backend
HmsDss.backend selects. "SHG": warp the grid to the Standard
Hydrologic Grid (USGS CONUS Albers, NAD 83, metres) with the gridded
importer of the native engine, ras_commander_fast_dss.gridded, and
store Albers grid records. This route needs the engine on every backend:
HEC Monolith has no warp, so there is no Java route and no shadow
comparison.
cell_size : float, optional
SHG cell size in metres; None means 2000 (the HEC-HMS SHG 2 km
lattice). Only with target_crs.
resample_method : str, default "bilinear"
"bilinear", "average" or "near". Only with target_crs.
envelope : sequence of float, optional
(min_x, min_y, max_x, max_y) of the SHG grid in metres. None:
the extent of the WGS 84 cells, projected and snapped to whole cells by
the engine. Only with target_crs.
sync : optional
Flush policy of the native writer (and of the SHG warp route), passed to
ras-commander-fast-dss unchanged. None (default) leaves the installed
engine's own default. The java backend does not use it.
Returns¶
Path Path to the output DSS file.
Raises¶
ImportError If pyjnius (Java backend) or ras_commander_fast_dss (native backend) is not installed. ValueError If a time is not a whole minute or has a time zone other than UTC, array dimensions don't match, the data type is unknown, or a PER-CUM or PER-AVER grid has no period (start at or after end). Raised on every backend before anything is written: HEC-HMS treats the cells of a period grid with equal start and end times as missing. RuntimeError If DSS write operation fails.
Examples¶
from hms_commander import HmsDssGrid import numpy as np from datetime import datetime, timedelta
Create synthetic grid (hourly data for 24 hours)¶
grid = np.random.rand(24, 10, 10) * 5.0 # 0-5 mm per hour lat = np.linspace(40.0, 41.0, 10) lon = np.linspace(-78.0, -77.0, 10) times = [datetime(2020, 5, 1) + timedelta(hours=i) for i in range(1, 25)] # period ends
Write to DSS¶
HmsDssGrid.write_grid_timeseries( ... dss_file="precip.dss", ... pathname="/AORC/WATERSHED/PRECIP////", ... grid_data=grid, ... lat_coords=lat, ... lon_coords=lon, ... timestamps=times, ... units="MM" ... )
Notes¶
- Without
target_crs, data is written in the WGS84 (lat/lon) coordinate system - Cell size is calculated as average of lat/lon spacing
- Grid origin is set to lower-left corner
- Uses SpecifiedGridInfo (not AlbersInfo) for lat/lon grids
- Implementation mirrors HEC-Vortex DssDataWriter.java
- The D part is the period start and the E part the period end (midnight is
0000in D and the previous day's2400in E), so the period ending 2020-05-02 00:00 is/01MAY2020:2300/01MAY2020:2400/. Instantaneous grids have the instant in both parts. HmsDss.backendselects HEC Monolith (java, default), the ras_commander_fast_dss engine (native) orshadow; the native writer stores the same specified-grid records as Monolith
See Also¶
HmsAorc.convert_to_dss_grid : Convenience method for AORC conversion
Source code in hms_commander/dss/hms_dss_grid.py
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 | |
get_features()
staticmethod
¶
Report which gridded feature groups the installed engine provides.
Does not raise when ras-commander-fast-dss is missing (every value is False).
Returns:
| Type | Description |
|---|---|
Dict[str, bool]
|
|
Dict[str, bool]
|
|
Dict[str, bool]
|
|
Source code in hms_commander/dss/hms_dss_grid.py
import_gridded(inputs, output, *, sync=None, **kwargs)
staticmethod
¶
Import grids from files into a DSS file, one frame at a time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inputs
|
Union[PathLike, Sequence[PathLike]]
|
One path or a sequence, read in the order given: GRIB2, NetCDF (classic and NetCDF-4), HDF5, GeoTIFF, ASCII grid, or the folder of a local Zarr v2 store. |
required |
output
|
PathLike
|
DSS file to write. It is created when the first record is written. |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
Options of |
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Raises:
| Type | Description |
|---|---|
ImportError
|
ras-commander-fast-dss is not installed. |
DssCapabilityError
|
The installed engine has no |
ValueError
|
The engine refuses the run (nothing is written). |
Source code in hms_commander/dss/hms_dss_grid.py
import_arrays(data, output, *, times, transform, crs, variable, source_units, sync=None, **kwargs)
staticmethod
¶
Import arrays through the same warp, unit, naming and writer steps as a file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
Any
|
Shape |
required |
output
|
PathLike
|
DSS file to write. |
required |
times
|
Sequence[Any]
|
One per frame: |
required |
transform
|
Sequence[float]
|
|
required |
crs
|
str
|
|
required |
variable
|
str
|
Variable name; it sets the C part. |
required |
source_units
|
str
|
Units the cells are in. |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
Other |
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Raises:
| Type | Description |
|---|---|
ImportError
|
ras-commander-fast-dss is not installed. |
DssCapabilityError
|
The installed engine has no |
Source code in hms_commander/dss/hms_dss_grid.py
import_zarr(inputs, output, *, variable, sync=None, **kwargs)
staticmethod
¶
Import a variable of local Zarr v2 stores (for example AORC v1.1) into DSS.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inputs
|
Union[PathLike, Sequence[PathLike]]
|
One store folder or a sequence of them. |
required |
output
|
PathLike
|
DSS file to write. |
required |
variable
|
str
|
Variable name (see |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
Other |
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Raises:
| Type | Description |
|---|---|
ImportError
|
ras-commander-fast-dss is not installed. |
DssCapabilityError
|
The installed engine has no |
Source code in hms_commander/dss/hms_dss_grid.py
list_variables(path)
staticmethod
¶
Variables a source file offers, by the names variable= takes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
PathLike
|
A GRIB2, NetCDF, HDF5, GeoTIFF or ASCII grid file (not a DSS file). Only metadata is read. |
required |
Returns:
| Type | Description |
|---|---|
List[str]
|
List of variable names. |
Source code in hms_commander/dss/hms_dss_grid.py
zarr_variables(path)
staticmethod
¶
Variables of a local Zarr v2 store, one dict each.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
PathLike
|
The store's folder. Only metadata and axes are read. |
required |
Returns:
| Type | Description |
|---|---|
List[Dict[str, Any]]
|
The engine's list of dicts ( |
List[Dict[str, Any]]
|
|
Source code in hms_commander/dss/hms_dss_grid.py
read_zarr(path, variable, *, steps, **kwargs)
staticmethod
¶
Read steps of a Zarr variable on a window, writing nothing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
PathLike
|
The store's folder. |
required |
variable
|
str
|
Variable name. |
required |
steps
|
Tuple[int, int]
|
|
required |
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
calculate(input, output, *, sync=None, **kwargs)
staticmethod
¶
Apply one operation by one constant to every valid cell of each grid.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
Source grids (a DSS file or a gridded source file). |
required |
output
|
PathLike
|
DSS file to write. |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
Exactly one of |
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
calculate_raster(input, raster, output, *, operation, sync=None, **kwargs)
staticmethod
¶
Combine each grid, on the left, with a raster resampled to it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
Source grids. |
required |
raster
|
PathLike
|
The raster operand (GeoTIFF, ASCII grid or a DSS grid). |
required |
output
|
PathLike
|
DSS file to write. |
required |
operation
|
str
|
|
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
sanitize(input, output, *, sync=None, **kwargs)
staticmethod
¶
Replace valid cells at or beyond thresholds.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
Source grids. |
required |
output
|
PathLike
|
DSS file to write. |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
clip(input, output, *, sync=None, **kwargs)
staticmethod
¶
Clip grids to an envelope, by nearest neighbour, in their own CRS.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
Source grids. |
required |
output
|
PathLike
|
DSS file to write. |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
normalize(input, normals, output, *, start, end, interval, sync=None, **kwargs)
staticmethod
¶
Scale each interval's source grids so their total matches its normals.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
Source grids. |
required |
normals
|
PathLike
|
Grids holding the totals to match. |
required |
output
|
PathLike
|
DSS file to write. |
required |
start
|
Any
|
Start of the first interval. |
required |
end
|
Any
|
End of the last interval. |
required |
interval
|
Any
|
A |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Any
|
|
Source code in hms_commander/dss/hms_dss_grid.py
shift_times(input, output, *, sync=None, **kwargs)
staticmethod
¶
Move grid records in time. Cell values are kept.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
DSS file holding the grids. |
required |
output
|
PathLike
|
DSS file to write. |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
resample_times(input, output, step_minutes, *, sync=None, **kwargs)
staticmethod
¶
Resample each grid series to a fixed time step.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
DSS file holding the grids. |
required |
output
|
PathLike
|
DSS file to write. |
required |
step_minutes
|
int
|
One of |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on |
None
|
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Any
|
the last whole window, which is not in the output. |
Source code in hms_commander/dss/hms_dss_grid.py
time_steps()
staticmethod
¶
The steps resample_times takes, in minutes.
Returns:
| Type | Description |
|---|---|
List[int]
|
List of |
series_info(input, pathname)
staticmethod
¶
What a grid series states: records, start, end, data type, units and grid.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
DSS file. |
required |
pathname
|
str
|
Any record of the series. |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
read_window(input, pathname, start, end=None, **kwargs)
staticmethod
¶
One window of a grid series, computed as resample_times computes it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
DSS file. |
required |
pathname
|
str
|
Any record of the series. |
required |
start
|
Any
|
Window start. |
required |
end
|
Optional[Any]
|
Window end; |
None
|
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
read_nearest(input, pathname, time, **kwargs)
staticmethod
¶
The grid record of a series nearest a time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
DSS file. |
required |
pathname
|
str
|
Any record of the series. |
required |
time
|
Any
|
The time to look near. |
required |
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
read_min_max(input, pathname, start, end, **kwargs)
staticmethod
¶
The minimum and maximum grids of a series over a window.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PathLike
|
DSS file. |
required |
pathname
|
str
|
Any record of the series. |
required |
start
|
Any
|
Window start. |
required |
end
|
Any
|
Window end. |
required |
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Tuple[Any, Any]
|
|
Source code in hms_commander/dss/hms_dss_grid.py
grid_to_point(grids, zones, zone_field, output, *, sync=None, **kwargs)
staticmethod
¶
Zonal statistics of each grid, written as one time series per zone and statistic.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
grids
|
PathLike
|
A DSS file, GRIB2 file, GeoTIFF or ASCII grid. |
required |
zones
|
PathLike
|
A shapefile or GeoJSON file of zones. |
required |
zone_field
|
str
|
The field that names each zone; it becomes the B part. |
required |
output
|
PathLike
|
DSS file to write the time series to. |
required |
sync
|
Optional[Any]
|
Flush policy, passed to the engine unchanged (see the class notes on
|
None
|
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Source code in hms_commander/dss/hms_dss_grid.py
zonal_statistics(grids, zones, zone_field, **kwargs)
staticmethod
¶
The statistics of grid_to_point as a table, writing nothing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
grids
|
PathLike
|
A DSS file, GRIB2 file, GeoTIFF or ASCII grid. |
required |
zones
|
PathLike
|
A shapefile or GeoJSON file of zones. |
required |
zone_field
|
str
|
The field that names each zone. |
required |
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The engine's |
Any
|
Missing statistics are NaN unless |
Source code in hms_commander/dss/hms_dss_grid.py
zone_masks(grids, zones, zone_field, **kwargs)
staticmethod
¶
Each zone's flat cell indices on the source's last grid.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
grids
|
PathLike
|
A DSS file, GRIB2 file, GeoTIFF or ASCII grid. |
required |
zones
|
PathLike
|
A shapefile or GeoJSON file of zones. |
required |
zone_field
|
str
|
The field that names each zone. |
required |
**kwargs
|
Any
|
|
{}
|
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
|
Source code in hms_commander/dss/hms_dss_grid.py
get_info()
staticmethod
¶
Get information about DSS grid format and requirements.
Returns¶
dict Information about DSS grid format including: - format: Description of DSS grid format - requirements: HMS requirements for gridded precip - classes: HEC Monolith classes used - references: Links to documentation
Examples¶
from hms_commander import HmsDssGrid info = HmsDssGrid.get_info() print(info['format']) 'HEC-DSS grid format with SpecifiedGridInfo for WGS84 lat/lon grids'