Lazy NetCDF cube#
Backs NetCDF.chunk(). A LazyNetCDF is the lazy twin of an eager cube: one dask.array.Array
per gridded variable, alongside the eager cube it was built from.
| Backend method | build_lazy_cube |
| Module | pyramids_lazy._lazy_cube |
| Returns | LazyNetCDF |
| Public as | pyramids.netcdf.LazyNetCDF |
from pyramids.netcdf import NetCDF
cube = NetCDF.read_file("era5.nc")
lazy = cube.chunk({"rows": 256, "cols": 256})
lazy.chunksizes # an alias of .chunks: per dimension, merged across the variables
eager = lazy.compute()
chunk takes the same spec as read_array: "auto", a single int, a sequence per axis, or a dict
keyed by rows / cols / columns / bands (case-insensitive) or by integer axis index. It is
not keyed by the file's dimension names — {"time": 24} raises ValueError.
Whether reduce(dim, how=…) stays lazy depends on what the view holds:
- a single variable (a cube pinned with
get_variable(…), or any view a composed op produced) composes lazily — it returns anotherLazyNetCDF, with no warning; - a multi-variable container cannot compose per block, so it materialises and runs eagerly, returning the eager cube and warning that it has done so.
Call compute() first when you want the eager path to be explicit rather than implied.
A wrapper, not a subclass#
LazyFeatureCollection can subclass dask_geopandas.GeoDataFrame because a feature collection
is one frame. A cube is many arrays, so there is no dask type to subclass — this is a wrapper
instead, holding the lazy arrays plus the eager cube that is both the source of its geo and band
metadata and the twin its lifecycle materialises back to.
The dask lifecycle members live here: chunks and chunksizes read the chunking off the arrays,
compute() and load() return the eager cube, persist() realises the graph in worker memory
while staying lazy, and unify_chunks() re-chunks every variable to a common grid.
API#
pyramids_lazy._lazy_cube.LazyNetCDF
#
A lazy, dask-backed view of a :class:~pyramids.netcdf.NetCDF cube.
Built by :meth:NetCDF.chunk. Holds a :class:dask.array.Array per gridded variable and the
eager cube they were read from; the eager cube supplies geo / band metadata and is the twin
returned by :meth:compute / :meth:load.
Attributes:
| Name | Type | Description |
|---|---|---|
variable_names |
list[str]
|
The gridded variables carried as dask arrays. |
Examples:
- A lazy view reports its chunking and computes back to its eager twin:
>>> from pyramids.netcdf import NetCDF # doctest: +SKIP
>>> lazy = NetCDF.read_file("cube.nc").chunk("auto") # doctest: +SKIP
>>> lazy.chunks # doctest: +SKIP
{'time': (4,), 'y': (256, 256), 'x': (256, 256)}
>>> eager = lazy.compute() # doctest: +SKIP
Source code in src/pyramids_lazy/_lazy_cube.py
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 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 | |
chunks
property
#
Per-dimension chunk sizes, keyed by dimension name.
Merged across variables — two variables that disagree on a shared dimension leave the last
one's chunking here until :meth:unify_chunks reconciles them.
chunksizes
property
#
Alias of :attr:chunks (xarray keeps both).
variable_names
property
#
The gridded variables this view carries, in build order.
__getattr__(name)
#
Delegate any eager operation to the source cube, warning once.
Reached only for names this wrapper does not define. A leading-underscore name is refused
outright (it is internal, not an operation). A public name absent from the eager cube also
raises :class:AttributeError without warning, so an existence probe (hasattr, feature
detection) neither warns spuriously nor burns the once-flag. The attribute is fetched exactly
once (a sentinel default on a single getattr, not a hasattr-then-getattr), so a property
getter on the source is not run twice.
A public name that exists forwards to :data:self._source directly, aliasing the source
(the load contract) rather than returning an independent :meth:compute copy: a functional
op returns a new cube and leaves the source intact, but an in-place mutator reached this way
would touch the source, so call :meth:compute first when you need an isolated eager cube.
This is the v1 lazy/eager boundary (array-native ops do not yet compose lazily); it emits a
one-time :class:UserWarning, and the once-flag is set only after warn returns, so a first
access under warnings-as-error does not silence later boundary warnings.
Source code in src/pyramids_lazy/_lazy_cube.py
__init__(source, arrays, dim_names, records=None)
#
Wrap per-variable dask arrays alongside the eager cube they came from.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source
|
NetCDF
|
The eager cube this view was built from — the source of its metadata and the
twin :meth: |
required |
arrays
|
dict[str, Any]
|
One dask array per gridded variable, laid out |
required |
dim_names
|
dict[str, tuple[str, ...]]
|
The dimension names per variable, outermost first, i.e.
|
required |
records
|
dict[str, _LazyVar] | None
|
Per-variable deferred state, set once an array-native op has composed over the
cube (#1237). When present the cube is transformed: :meth: |
None
|
Source code in src/pyramids_lazy/_lazy_cube.py
__repr__()
#
A short, dask-aware summary naming the variables and their chunking.
argmax(dim, *, skipna=True)
#
Position of the maximum along a band dimension, composing lazily (#1237).
argmin(dim, *, skipna=True)
#
Position of the minimum along a band dimension, composing lazily (#1237).
clip(min=None, max=None)
#
Bound the values to [min, max], composing lazily (#1237); a gap stays a gap.
Cell-wise and shape-preserving, so it runs the eager :meth:NetCDF.clip per spatial block
via map_blocks (bit-for-bit; the dtype widening is bound-based, so it is the same for every
block). A multi-variable container clips eagerly at the boundary, warning once.
Source code in src/pyramids_lazy/_lazy_cube.py
coarsen(dim, window, *, how='mean', boundary='exact', skipna=True, q=None)
#
Block-aggregate a band dimension into windows, composing lazily for a single variable.
The lazy twin of :meth:NetCDF.coarsen — the same grouped reduction, kept as a deferred
dask.array step so it composes with other lazy ops. A multi-variable container
materialises at the boundary and coarsens eagerly, warning once (as :meth:reduce does).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dim
|
str
|
The band dimension to block-aggregate. |
required |
window
|
int
|
The number of steps per window. |
required |
how
|
str
|
The reduction, as :meth: |
'mean'
|
boundary
|
str
|
How a trailing partial window is handled ( |
'exact'
|
skipna
|
bool
|
Whether gaps are skipped. |
True
|
q
|
float | None
|
The quantile, for |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube for a pinned variable; an eager coarsened cube for a |
Any
|
multi-variable container. |
Source code in src/pyramids_lazy/_lazy_cube.py
compute(**kwargs)
#
Materialise the lazy view and return an independent eager NetCDF cube.
The lazy arrays are chunked reads of the source cube, so the result holds the same data; it is
returned as an independent copy (compute() is not the source), matching xarray's compute(),
so mutating the result never touches the original or any other compute() result. The
**kwargs are accepted for API symmetry with xarray / dask and ignored — in this v1 the data is
a view of the already-eager source, so nothing has to be scheduled.
Returns:
| Name | Type | Description |
|---|---|---|
NetCDF |
NetCDF
|
A fresh eager cube, independent of the source. |
Source code in src/pyramids_lazy/_lazy_cube.py
cumsum(dim, *, skipna=True)
#
Running total along a band dimension, composing lazily (#1237).
The lazy twin of :meth:NetCDF.cumsum; the cumulative sum stays a deferred dask.array
step, keeping the dimension's length. A multi-variable container totals eagerly at the
boundary, warning once.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dim
|
str
|
The band dimension to total along. |
required |
skipna
|
bool
|
Whether gaps are skipped. |
True
|
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube for a pinned variable; an eager totalled cube otherwise. |
Source code in src/pyramids_lazy/_lazy_cube.py
diff(dim, n=1, *, label='upper')
#
Difference neighbouring steps along a band dimension, composing lazily (#1237).
The lazy twin of :meth:NetCDF.diff; the difference stays a deferred dask.array step.
A multi-variable container differences eagerly at the boundary, warning once.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dim
|
str
|
The band dimension to difference along. |
required |
n
|
int
|
The order (how many times the difference is taken). |
1
|
label
|
str
|
|
'upper'
|
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube for a pinned variable; an eager diffed cube otherwise. |
Source code in src/pyramids_lazy/_lazy_cube.py
fillna(value)
#
Fill the gaps with value, composing lazily (#1237).
Cell-wise and shape-preserving; runs the eager :meth:NetCDF.fillna per block via
map_blocks. A multi-variable container fills eagerly at the boundary, warning once.
Source code in src/pyramids_lazy/_lazy_cube.py
idxmax(dim, *, skipna=True)
#
Coordinate of the maximum along a band dimension, composing lazily (#1237).
idxmin(dim, *, skipna=True)
#
Coordinate of the minimum along a band dimension, composing lazily (#1237).
interp(method='linear', **coords)
#
Interpolate band dimensions onto new coordinate values, composing lazily (#1237).
The lazy twin of :meth:NetCDF.interp; each dim=targets interpolation (a scipy kernel)
runs per spatial block via map_blocks, resizing the dimension to the target length. Several
dim=targets pairs compose in sequence. A multi-variable container interpolates eagerly at
the boundary, warning once.
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube for a pinned variable; an eager result otherwise. |
Source code in src/pyramids_lazy/_lazy_cube.py
interpolate_na(dim, method='linear', *, limit=None, use_coordinate=True)
#
Fill interior gaps along a band dimension, composing lazily (#1237).
The lazy twin of :meth:NetCDF.interpolate_na; the interpolation (a scipy kernel) runs per
spatial block via map_blocks, keeping the dimension's length. A multi-variable container
interpolates eagerly at the boundary, warning once.
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube for a pinned variable; an eager result otherwise. |
Source code in src/pyramids_lazy/_lazy_cube.py
isel(*, drop=False, **indexers)
#
Select bands by position along band dimensions, composing lazily (#1237).
Pure band-axis indexing, so it stays lazy: each selector is resolved to positions (the same
_resolve_positional_indices :meth:NetCDF.isel uses) and the dask array is indexed along
that axis, the coordinates narrowed to match; drop=True squeezes the axes a scalar
selector collapsed. A multi-variable container selects eagerly at the boundary, warning once.
Source code in src/pyramids_lazy/_lazy_cube.py
load(**kwargs)
#
Materialise in place and return the eager cube — the in-place form of :meth:compute.
Matches xarray's load, which realises in place and returns the same object: this returns the
source cube itself (not a copy), so it aliases the cube .chunk() was called on. Use
:meth:compute when you need an independent result. The **kwargs are accepted for symmetry
and ignored.
Returns:
| Name | Type | Description |
|---|---|---|
NetCDF |
NetCDF
|
The source cube (the eager twin), realised in place. A transformed cube |
NetCDF
|
(a composed op) has no untransformed source to alias, so it returns the rebuilt eager |
|
NetCDF
|
result, as :meth: |
Source code in src/pyramids_lazy/_lazy_cube.py
pad(*, mode='constant', constant_values=None, **pad_width)
#
Pad band dimensions with a constant fill, composing lazily (#1237).
The lazy twin of :meth:NetCDF.pad for band dimensions (extended via map_blocks). A
spatial-axis pad moves the geotransform (a GDAL op) and a multi-variable container cannot
compose, so either materialises at the boundary, warning once; several band dimensions in
one call compose in sequence.
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube when every padded dimension is a band dimension of a |
Any
|
single variable; an eager padded cube otherwise. |
Source code in src/pyramids_lazy/_lazy_cube.py
persist(**kwargs)
#
Realise the dask graph in worker memory, staying lazy.
Returns a new :class:LazyNetCDF whose arrays are dask.persist-ed — the graph is kept but
its results are held in memory / across the cluster, so later reads do not recompute it.
A composed array-native op survives the round trip: the deferred per-variable records are
carried onto the new view, exactly as unify_chunks() carries them, so persist().compute()
rebuilds the transformed cube instead of falling back to the untransformed source. A view
straight from NetCDF.chunk() carries no records, and persist() invents none.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Any
|
Forwarded verbatim to |
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
LazyNetCDF |
LazyNetCDF
|
A lazy view over the persisted arrays, keeping this view's chunking and its |
LazyNetCDF
|
composed op. |
Examples:
- Persisting stays lazy and keeps the chunking:
>>> from pyramids.netcdf import NetCDF >>> cube = NetCDF.read_file("tests/data/netcdf/cf__5v__1d4-4d1__y-asc.nc") >>> lazy = cube.get_variable("temperature").chunk("auto") >>> lazy.chunks {'time': (4,), 'pressure_level': (3,), 'lat': (5,), 'lon': (6,)} >>> lazy.persist().chunks == lazy.chunks True >>> cube.close() - A composed reduction survives persisting: the view computes to the time-collapsed
result, not back to the four-step source it was read from:
>>> from pyramids.netcdf import NetCDF >>> cube = NetCDF.read_file("tests/data/netcdf/cf__5v__1d4-4d1__y-asc.nc") >>> lazy = cube.get_variable("temperature").chunk("auto") >>> lazy.compute().read_array().shape (4, 3, 5, 6) >>> lazy.reduce("time", "mean").persist().compute().read_array().shape (3, 5, 6) >>> cube.close()
See Also
unify_chunks: Reconciles shared-dimension chunking across two or more variables; a composed (single-variable) view is already unified, so it is returned unchanged. compute: Materialises the view — the rebuilt transformed cube once an op has composed.
Source code in src/pyramids_lazy/_lazy_cube.py
rank(dim, *, pct=False)
#
Rank each pixel's values along a band dimension, composing lazily (#1237).
The lazy twin of :meth:NetCDF.rank. rank uses scipy.stats.rankdata, which needs a
numpy array, so it cannot stay a pure dask graph; instead the eager kernel runs per spatial
block (the band axis whole) through dask.array.map_blocks, which is lazy and bit-for-bit
with the eager rank. A multi-variable container ranks eagerly at the boundary, warning once.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dim
|
str
|
The band dimension to rank along. |
required |
pct
|
bool
|
Whether to return ranks as a fraction of the valid count. |
False
|
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube for a pinned variable; an eager ranked cube otherwise. |
Source code in src/pyramids_lazy/_lazy_cube.py
reduce(dim, how='mean', *, skipna=True, q=None)
#
Reduce a band dimension, composing lazily when the cube is a single variable (#1237).
Collapses dim with how, keeping the result a lazy cube: the reduction is a dask.array
step deferred until :meth:compute, so a chain of reductions stays lazy and reads the store
only once per block. Mirrors :meth:NetCDF.reduce.
A single pinned variable composes lazily and returns a :class:LazyNetCDF. A multi-variable
container cannot yet compose at the cube level, so it auto-materialises to the eager cube and
reduces there, warning once — the v1 lazy/eager boundary (the same shape as the GDAL-op
boundary). Pin a variable with get_variable(...) first to keep a container reduce lazy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dim
|
str
|
The band dimension to collapse. |
required |
how
|
str
|
The reduction ( |
'mean'
|
skipna
|
bool
|
Whether gaps are skipped. |
True
|
q
|
float | None
|
The quantile, for |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube for a pinned variable; an eager reduced cube for a |
Any
|
multi-variable container (materialised at the boundary). |
Source code in src/pyramids_lazy/_lazy_cube.py
rolling(dim, window, *, how='mean', center=False, min_periods=None, q=None)
#
Moving-window reduction along a band dimension, composing lazily for a single variable.
The lazy twin of :meth:NetCDF.rolling — the window reduction stays a deferred
dask.array step. A multi-variable container materialises at the boundary, warning once.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dim
|
str
|
The band dimension to roll along. |
required |
window
|
int
|
The window length in steps. |
required |
how
|
str
|
The reduction, as :meth: |
'mean'
|
center
|
bool
|
Whether the window is centred rather than trailing. |
False
|
min_periods
|
int | None
|
The minimum valid steps for a non-gap result; defaults to |
None
|
q
|
float | None
|
The quantile, for |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube for a pinned variable; an eager rolled cube otherwise. |
Source code in src/pyramids_lazy/_lazy_cube.py
round(decimals=0)
#
Round the values, composing lazily (#1237); a gap stays a gap.
Cell-wise and shape-preserving; runs the eager :meth:NetCDF.round per block via
map_blocks. An integer band rounded to tens (decimals < 0) may widen based on the data,
which is not consistent across blocks, so that case materialises at the boundary, as does a
multi-variable container — both warn once.
Source code in src/pyramids_lazy/_lazy_cube.py
sel(*, method=None, tolerance=None, **kwargs)
#
Select bands by coordinate value along band dimensions, composing lazily (#1237).
The value twin of :meth:isel: each selector is resolved to positions against the source
coordinates (the same _resolve_one_dim :meth:NetCDF.sel uses, honouring
method="nearest" / tolerance), then the dask array is indexed — staying lazy. A
multi-variable container selects eagerly at the boundary, warning once.
Source code in src/pyramids_lazy/_lazy_cube.py
shift(dim, periods=1, *, fill_value=None)
#
Shift values along a band dimension, composing lazily (#1237).
The lazy twin of :meth:NetCDF.shift; the shift stays a deferred dask.array step,
keeping the dimension's length. A multi-variable container shifts eagerly at the boundary,
warning once.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dim
|
str
|
The band dimension to shift along. |
required |
periods
|
int
|
How many steps to move (positive towards the end, negative the other way). |
1
|
fill_value
|
Any
|
The value for the vacated steps; the variable's no-data (or NaN) by default. |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
LazyNetCDF | NetCDF: A lazy cube for a pinned variable; an eager shifted cube otherwise. |
Source code in src/pyramids_lazy/_lazy_cube.py
squeeze(dim=None)
#
Drop length-one band dimensions, composing lazily (#1237).
Pure band-axis reshape (no data touched), so it stays lazy: the dask array's size-1 band
axes are squeezed and the band metadata narrowed to match :meth:NetCDF.squeeze. A
multi-variable container squeezes eagerly at the boundary, warning once.
Source code in src/pyramids_lazy/_lazy_cube.py
transpose(*dims)
#
Reorder the band dimensions (spatial plane stays trailing), composing lazily (#1237).
Pure band-axis permutation, so it stays lazy: _transpose_order resolves and validates the
order (as :meth:NetCDF.transpose), then the dask array's band axes are permuted. A
multi-variable container transposes eagerly at the boundary, warning once.
Source code in src/pyramids_lazy/_lazy_cube.py
unify_chunks()
#
Re-chunk every variable to a common chunking across their shared dimensions.
A no-op when the view holds fewer than two variables — that view is returned unchanged. Two
variables chunked differently on a shared dimension come out sharing one chunking afterward.
A composed array-native op is carried onto the result, as it is through persist().
Returns:
| Name | Type | Description |
|---|---|---|
LazyNetCDF |
LazyNetCDF
|
A lazy view whose variables agree on their shared-dimension chunking. |
Source code in src/pyramids_lazy/_lazy_cube.py
pyramids_lazy._lazy_cube.build_lazy_cube(nc, chunks='auto')
#
Build a lazy, dask-backed :class:LazyNetCDF view of nc (backs NetCDF.chunk).
Every gridded variable is read lazily through nc.read_array with chunks and wrapped in a
:class:LazyNetCDF. Only a file-backed cube can be chunked -- the lazy read reopens the store per
block -- so an in-memory / in-place-rebuilt cube is refused.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
nc
|
NetCDF
|
The file-backed NetCDF container (or pinned single variable) to view lazily. |
required |
chunks
|
Any
|
The dask chunk spec forwarded to |
'auto'
|
Returns:
| Name | Type | Description |
|---|---|---|
LazyNetCDF |
LazyNetCDF
|
A lazy view whose variables are dask arrays over |
Raises:
| Type | Description |
|---|---|
ValueError
|
|