1.. currentmodule:: xarray 2 3.. _api: 4 5############# 6API reference 7############# 8 9This page provides an auto-generated summary of xarray's API. For more details 10and examples, refer to the relevant chapters in the main part of the 11documentation. 12 13See also: :ref:`public api` 14 15Top-level functions 16=================== 17 18.. autosummary:: 19 :toctree: generated/ 20 21 apply_ufunc 22 align 23 broadcast 24 concat 25 merge 26 combine_by_coords 27 combine_nested 28 where 29 infer_freq 30 full_like 31 zeros_like 32 ones_like 33 cov 34 corr 35 dot 36 polyval 37 map_blocks 38 show_versions 39 set_options 40 get_options 41 unify_chunks 42 43Dataset 44======= 45 46Creating a dataset 47------------------ 48 49.. autosummary:: 50 :toctree: generated/ 51 52 Dataset 53 decode_cf 54 55Attributes 56---------- 57 58.. autosummary:: 59 :toctree: generated/ 60 61 Dataset.dims 62 Dataset.sizes 63 Dataset.data_vars 64 Dataset.coords 65 Dataset.attrs 66 Dataset.encoding 67 Dataset.indexes 68 Dataset.chunks 69 Dataset.chunksizes 70 Dataset.nbytes 71 72Dictionary interface 73-------------------- 74 75Datasets implement the mapping interface with keys given by variable names 76and values given by ``DataArray`` objects. 77 78.. autosummary:: 79 :toctree: generated/ 80 81 Dataset.__getitem__ 82 Dataset.__setitem__ 83 Dataset.__delitem__ 84 Dataset.update 85 Dataset.get 86 Dataset.items 87 Dataset.keys 88 Dataset.values 89 90Dataset contents 91---------------- 92 93.. autosummary:: 94 :toctree: generated/ 95 96 Dataset.copy 97 Dataset.assign 98 Dataset.assign_coords 99 Dataset.assign_attrs 100 Dataset.pipe 101 Dataset.merge 102 Dataset.rename 103 Dataset.rename_vars 104 Dataset.rename_dims 105 Dataset.swap_dims 106 Dataset.expand_dims 107 Dataset.drop_vars 108 Dataset.drop_dims 109 Dataset.set_coords 110 Dataset.reset_coords 111 Dataset.get_index 112 113Comparisons 114----------- 115 116.. autosummary:: 117 :toctree: generated/ 118 119 Dataset.equals 120 Dataset.identical 121 Dataset.broadcast_equals 122 123Indexing 124-------- 125 126.. autosummary:: 127 :toctree: generated/ 128 129 Dataset.loc 130 Dataset.isel 131 Dataset.sel 132 Dataset.drop_sel 133 Dataset.drop_isel 134 Dataset.head 135 Dataset.tail 136 Dataset.thin 137 Dataset.squeeze 138 Dataset.interp 139 Dataset.interp_like 140 Dataset.reindex 141 Dataset.reindex_like 142 Dataset.set_index 143 Dataset.reset_index 144 Dataset.reorder_levels 145 Dataset.query 146 147Missing value handling 148---------------------- 149 150.. autosummary:: 151 :toctree: generated/ 152 153 Dataset.isnull 154 Dataset.notnull 155 Dataset.combine_first 156 Dataset.count 157 Dataset.dropna 158 Dataset.fillna 159 Dataset.ffill 160 Dataset.bfill 161 Dataset.interpolate_na 162 Dataset.where 163 Dataset.isin 164 165Computation 166----------- 167 168.. autosummary:: 169 :toctree: generated/ 170 171 Dataset.map 172 Dataset.reduce 173 Dataset.groupby 174 Dataset.groupby_bins 175 Dataset.rolling 176 Dataset.rolling_exp 177 Dataset.weighted 178 Dataset.coarsen 179 Dataset.resample 180 Dataset.diff 181 Dataset.quantile 182 Dataset.differentiate 183 Dataset.integrate 184 Dataset.map_blocks 185 Dataset.polyfit 186 Dataset.curvefit 187 188Aggregation 189----------- 190 191.. autosummary:: 192 :toctree: generated/ 193 194 Dataset.all 195 Dataset.any 196 Dataset.argmax 197 Dataset.argmin 198 Dataset.idxmax 199 Dataset.idxmin 200 Dataset.max 201 Dataset.min 202 Dataset.mean 203 Dataset.median 204 Dataset.prod 205 Dataset.sum 206 Dataset.std 207 Dataset.var 208 Dataset.cumsum 209 Dataset.cumprod 210 211ndarray methods 212--------------- 213 214.. autosummary:: 215 :toctree: generated/ 216 217 Dataset.argsort 218 Dataset.astype 219 Dataset.clip 220 Dataset.conj 221 Dataset.conjugate 222 Dataset.imag 223 Dataset.round 224 Dataset.real 225 Dataset.rank 226 227Reshaping and reorganizing 228-------------------------- 229 230.. autosummary:: 231 :toctree: generated/ 232 233 Dataset.transpose 234 Dataset.stack 235 Dataset.unstack 236 Dataset.to_stacked_array 237 Dataset.shift 238 Dataset.roll 239 Dataset.pad 240 Dataset.sortby 241 Dataset.broadcast_like 242 243Plotting 244-------- 245 246.. autosummary:: 247 :toctree: generated/ 248 :template: autosummary/accessor_method.rst 249 250 Dataset.plot.scatter 251 Dataset.plot.quiver 252 Dataset.plot.streamplot 253 254DataArray 255========= 256 257.. autosummary:: 258 :toctree: generated/ 259 260 DataArray 261 262Attributes 263---------- 264 265.. autosummary:: 266 :toctree: generated/ 267 268 DataArray.values 269 DataArray.data 270 DataArray.coords 271 DataArray.dims 272 DataArray.sizes 273 DataArray.name 274 DataArray.attrs 275 DataArray.encoding 276 DataArray.indexes 277 DataArray.chunksizes 278 279ndarray attributes 280------------------ 281 282.. autosummary:: 283 :toctree: generated/ 284 285 DataArray.ndim 286 DataArray.nbytes 287 DataArray.shape 288 DataArray.size 289 DataArray.dtype 290 DataArray.nbytes 291 DataArray.chunks 292 293 294DataArray contents 295------------------ 296 297.. autosummary:: 298 :toctree: generated/ 299 300 DataArray.assign_coords 301 DataArray.assign_attrs 302 DataArray.pipe 303 DataArray.rename 304 DataArray.swap_dims 305 DataArray.expand_dims 306 DataArray.drop_vars 307 DataArray.drop_duplicates 308 DataArray.reset_coords 309 DataArray.copy 310 DataArray.get_index 311 DataArray.astype 312 DataArray.item 313 314Indexing 315-------- 316 317.. autosummary:: 318 :toctree: generated/ 319 320 DataArray.__getitem__ 321 DataArray.__setitem__ 322 DataArray.loc 323 DataArray.isel 324 DataArray.sel 325 DataArray.drop_sel 326 DataArray.drop_isel 327 DataArray.head 328 DataArray.tail 329 DataArray.thin 330 DataArray.squeeze 331 DataArray.interp 332 DataArray.interp_like 333 DataArray.reindex 334 DataArray.reindex_like 335 DataArray.set_index 336 DataArray.reset_index 337 DataArray.reorder_levels 338 DataArray.query 339 340Missing value handling 341---------------------- 342 343.. autosummary:: 344 :toctree: generated/ 345 346 DataArray.isnull 347 DataArray.notnull 348 DataArray.combine_first 349 DataArray.count 350 DataArray.dropna 351 DataArray.fillna 352 DataArray.ffill 353 DataArray.bfill 354 DataArray.interpolate_na 355 DataArray.where 356 DataArray.isin 357 358Comparisons 359----------- 360 361.. autosummary:: 362 :toctree: generated/ 363 364 DataArray.equals 365 DataArray.identical 366 DataArray.broadcast_equals 367 368Computation 369----------- 370 371.. autosummary:: 372 :toctree: generated/ 373 374 DataArray.reduce 375 DataArray.groupby 376 DataArray.groupby_bins 377 DataArray.rolling 378 DataArray.rolling_exp 379 DataArray.weighted 380 DataArray.coarsen 381 DataArray.resample 382 DataArray.get_axis_num 383 DataArray.diff 384 DataArray.dot 385 DataArray.quantile 386 DataArray.differentiate 387 DataArray.integrate 388 DataArray.polyfit 389 DataArray.map_blocks 390 DataArray.curvefit 391 392Aggregation 393----------- 394 395.. autosummary:: 396 :toctree: generated/ 397 398 DataArray.all 399 DataArray.any 400 DataArray.argmax 401 DataArray.argmin 402 DataArray.idxmax 403 DataArray.idxmin 404 DataArray.max 405 DataArray.min 406 DataArray.mean 407 DataArray.median 408 DataArray.prod 409 DataArray.sum 410 DataArray.std 411 DataArray.var 412 DataArray.cumsum 413 DataArray.cumprod 414 415ndarray methods 416--------------- 417 418.. autosummary:: 419 :toctree: generated/ 420 421 DataArray.argsort 422 DataArray.clip 423 DataArray.conj 424 DataArray.conjugate 425 DataArray.imag 426 DataArray.searchsorted 427 DataArray.round 428 DataArray.real 429 DataArray.T 430 DataArray.rank 431 432 433String manipulation 434------------------- 435 436.. autosummary:: 437 :toctree: generated/ 438 :template: autosummary/accessor.rst 439 440 DataArray.str 441 442.. autosummary:: 443 :toctree: generated/ 444 :template: autosummary/accessor_method.rst 445 446 DataArray.str.capitalize 447 DataArray.str.casefold 448 DataArray.str.cat 449 DataArray.str.center 450 DataArray.str.contains 451 DataArray.str.count 452 DataArray.str.decode 453 DataArray.str.encode 454 DataArray.str.endswith 455 DataArray.str.extract 456 DataArray.str.extractall 457 DataArray.str.find 458 DataArray.str.findall 459 DataArray.str.format 460 DataArray.str.get 461 DataArray.str.get_dummies 462 DataArray.str.index 463 DataArray.str.isalnum 464 DataArray.str.isalpha 465 DataArray.str.isdecimal 466 DataArray.str.isdigit 467 DataArray.str.islower 468 DataArray.str.isnumeric 469 DataArray.str.isspace 470 DataArray.str.istitle 471 DataArray.str.isupper 472 DataArray.str.join 473 DataArray.str.len 474 DataArray.str.ljust 475 DataArray.str.lower 476 DataArray.str.lstrip 477 DataArray.str.match 478 DataArray.str.normalize 479 DataArray.str.pad 480 DataArray.str.partition 481 DataArray.str.repeat 482 DataArray.str.replace 483 DataArray.str.rfind 484 DataArray.str.rindex 485 DataArray.str.rjust 486 DataArray.str.rpartition 487 DataArray.str.rsplit 488 DataArray.str.rstrip 489 DataArray.str.slice 490 DataArray.str.slice_replace 491 DataArray.str.split 492 DataArray.str.startswith 493 DataArray.str.strip 494 DataArray.str.swapcase 495 DataArray.str.title 496 DataArray.str.translate 497 DataArray.str.upper 498 DataArray.str.wrap 499 DataArray.str.zfill 500 501Datetimelike properties 502----------------------- 503 504**Datetime properties**: 505 506.. autosummary:: 507 :toctree: generated/ 508 :template: autosummary/accessor_attribute.rst 509 510 DataArray.dt.year 511 DataArray.dt.month 512 DataArray.dt.day 513 DataArray.dt.hour 514 DataArray.dt.minute 515 DataArray.dt.second 516 DataArray.dt.microsecond 517 DataArray.dt.nanosecond 518 DataArray.dt.dayofweek 519 DataArray.dt.weekday 520 DataArray.dt.weekday_name 521 DataArray.dt.dayofyear 522 DataArray.dt.quarter 523 DataArray.dt.days_in_month 524 DataArray.dt.daysinmonth 525 DataArray.dt.season 526 DataArray.dt.time 527 DataArray.dt.date 528 DataArray.dt.is_month_start 529 DataArray.dt.is_month_end 530 DataArray.dt.is_quarter_end 531 DataArray.dt.is_year_start 532 DataArray.dt.is_leap_year 533 534**Datetime methods**: 535 536.. autosummary:: 537 :toctree: generated/ 538 :template: autosummary/accessor_method.rst 539 540 DataArray.dt.floor 541 DataArray.dt.ceil 542 DataArray.dt.isocalendar 543 DataArray.dt.round 544 DataArray.dt.strftime 545 546**Timedelta properties**: 547 548.. autosummary:: 549 :toctree: generated/ 550 :template: autosummary/accessor_attribute.rst 551 552 DataArray.dt.days 553 DataArray.dt.seconds 554 DataArray.dt.microseconds 555 DataArray.dt.nanoseconds 556 557**Timedelta methods**: 558 559.. autosummary:: 560 :toctree: generated/ 561 :template: autosummary/accessor_method.rst 562 563 DataArray.dt.floor 564 DataArray.dt.ceil 565 DataArray.dt.round 566 567 568Reshaping and reorganizing 569-------------------------- 570 571.. autosummary:: 572 :toctree: generated/ 573 574 DataArray.transpose 575 DataArray.stack 576 DataArray.unstack 577 DataArray.to_unstacked_dataset 578 DataArray.shift 579 DataArray.roll 580 DataArray.pad 581 DataArray.sortby 582 DataArray.broadcast_like 583 584Plotting 585-------- 586 587.. autosummary:: 588 :toctree: generated/ 589 :template: autosummary/accessor_callable.rst 590 591 DataArray.plot 592 593.. autosummary:: 594 :toctree: generated/ 595 :template: autosummary/accessor_method.rst 596 597 DataArray.plot.contourf 598 DataArray.plot.contour 599 DataArray.plot.hist 600 DataArray.plot.imshow 601 DataArray.plot.line 602 DataArray.plot.pcolormesh 603 DataArray.plot.step 604 DataArray.plot.surface 605 606.. _api.ufuncs: 607 608Universal functions 609=================== 610 611.. warning:: 612 613 With recent versions of NumPy, Dask and xarray, NumPy ufuncs are now 614 supported directly on all xarray and Dask objects. This obviates the need 615 for the ``xarray.ufuncs`` module, which should not be used for new code 616 unless compatibility with versions of NumPy prior to v1.13 is 617 required. They will be removed once support for NumPy prior to 618 v1.17 is dropped. 619 620These functions are copied from NumPy, but extended to work on NumPy arrays, 621dask arrays and all xarray objects. You can find them in the ``xarray.ufuncs`` 622module: 623 624:py:attr:`~ufuncs.angle` 625:py:attr:`~ufuncs.arccos` 626:py:attr:`~ufuncs.arccosh` 627:py:attr:`~ufuncs.arcsin` 628:py:attr:`~ufuncs.arcsinh` 629:py:attr:`~ufuncs.arctan` 630:py:attr:`~ufuncs.arctan2` 631:py:attr:`~ufuncs.arctanh` 632:py:attr:`~ufuncs.ceil` 633:py:attr:`~ufuncs.conj` 634:py:attr:`~ufuncs.copysign` 635:py:attr:`~ufuncs.cos` 636:py:attr:`~ufuncs.cosh` 637:py:attr:`~ufuncs.deg2rad` 638:py:attr:`~ufuncs.degrees` 639:py:attr:`~ufuncs.exp` 640:py:attr:`~ufuncs.expm1` 641:py:attr:`~ufuncs.fabs` 642:py:attr:`~ufuncs.fix` 643:py:attr:`~ufuncs.floor` 644:py:attr:`~ufuncs.fmax` 645:py:attr:`~ufuncs.fmin` 646:py:attr:`~ufuncs.fmod` 647:py:attr:`~ufuncs.fmod` 648:py:attr:`~ufuncs.frexp` 649:py:attr:`~ufuncs.hypot` 650:py:attr:`~ufuncs.imag` 651:py:attr:`~ufuncs.iscomplex` 652:py:attr:`~ufuncs.isfinite` 653:py:attr:`~ufuncs.isinf` 654:py:attr:`~ufuncs.isnan` 655:py:attr:`~ufuncs.isreal` 656:py:attr:`~ufuncs.ldexp` 657:py:attr:`~ufuncs.log` 658:py:attr:`~ufuncs.log10` 659:py:attr:`~ufuncs.log1p` 660:py:attr:`~ufuncs.log2` 661:py:attr:`~ufuncs.logaddexp` 662:py:attr:`~ufuncs.logaddexp2` 663:py:attr:`~ufuncs.logical_and` 664:py:attr:`~ufuncs.logical_not` 665:py:attr:`~ufuncs.logical_or` 666:py:attr:`~ufuncs.logical_xor` 667:py:attr:`~ufuncs.maximum` 668:py:attr:`~ufuncs.minimum` 669:py:attr:`~ufuncs.nextafter` 670:py:attr:`~ufuncs.rad2deg` 671:py:attr:`~ufuncs.radians` 672:py:attr:`~ufuncs.real` 673:py:attr:`~ufuncs.rint` 674:py:attr:`~ufuncs.sign` 675:py:attr:`~ufuncs.signbit` 676:py:attr:`~ufuncs.sin` 677:py:attr:`~ufuncs.sinh` 678:py:attr:`~ufuncs.sqrt` 679:py:attr:`~ufuncs.square` 680:py:attr:`~ufuncs.tan` 681:py:attr:`~ufuncs.tanh` 682:py:attr:`~ufuncs.trunc` 683 684IO / Conversion 685=============== 686 687Dataset methods 688--------------- 689 690.. autosummary:: 691 :toctree: generated/ 692 693 open_dataset 694 load_dataset 695 open_mfdataset 696 open_rasterio 697 open_zarr 698 Dataset.to_netcdf 699 Dataset.to_pandas 700 Dataset.as_numpy 701 Dataset.to_zarr 702 save_mfdataset 703 Dataset.to_array 704 Dataset.to_dataframe 705 Dataset.to_dask_dataframe 706 Dataset.to_dict 707 Dataset.from_dataframe 708 Dataset.from_dict 709 Dataset.close 710 Dataset.compute 711 Dataset.persist 712 Dataset.load 713 Dataset.chunk 714 Dataset.unify_chunks 715 Dataset.filter_by_attrs 716 Dataset.info 717 718DataArray methods 719----------------- 720 721.. autosummary:: 722 :toctree: generated/ 723 724 open_dataarray 725 load_dataarray 726 DataArray.to_dataset 727 DataArray.to_netcdf 728 DataArray.to_pandas 729 DataArray.to_series 730 DataArray.to_dataframe 731 DataArray.to_numpy 732 DataArray.as_numpy 733 DataArray.to_index 734 DataArray.to_masked_array 735 DataArray.to_cdms2 736 DataArray.to_iris 737 DataArray.from_iris 738 DataArray.to_dict 739 DataArray.from_series 740 DataArray.from_cdms2 741 DataArray.from_dict 742 DataArray.close 743 DataArray.compute 744 DataArray.persist 745 DataArray.load 746 DataArray.chunk 747 DataArray.unify_chunks 748 749Coordinates objects 750=================== 751 752.. autosummary:: 753 :toctree: generated/ 754 755 core.coordinates.DataArrayCoordinates 756 core.coordinates.DatasetCoordinates 757 758GroupBy objects 759=============== 760 761.. currentmodule:: xarray.core.groupby 762 763Dataset 764------- 765 766.. autosummary:: 767 :toctree: generated/ 768 769 DatasetGroupBy 770 DatasetGroupBy.map 771 DatasetGroupBy.reduce 772 DatasetGroupBy.assign 773 DatasetGroupBy.assign_coords 774 DatasetGroupBy.first 775 DatasetGroupBy.last 776 DatasetGroupBy.fillna 777 DatasetGroupBy.quantile 778 DatasetGroupBy.where 779 DatasetGroupBy.all 780 DatasetGroupBy.any 781 DatasetGroupBy.count 782 DatasetGroupBy.max 783 DatasetGroupBy.mean 784 DatasetGroupBy.median 785 DatasetGroupBy.min 786 DatasetGroupBy.prod 787 DatasetGroupBy.std 788 DatasetGroupBy.sum 789 DatasetGroupBy.var 790 DatasetGroupBy.dims 791 DatasetGroupBy.groups 792 793DataArray 794--------- 795 796.. autosummary:: 797 :toctree: generated/ 798 799 DataArrayGroupBy 800 DataArrayGroupBy.map 801 DataArrayGroupBy.reduce 802 DataArrayGroupBy.assign_coords 803 DataArrayGroupBy.first 804 DataArrayGroupBy.last 805 DataArrayGroupBy.fillna 806 DataArrayGroupBy.quantile 807 DataArrayGroupBy.where 808 DataArrayGroupBy.all 809 DataArrayGroupBy.any 810 DataArrayGroupBy.count 811 DataArrayGroupBy.max 812 DataArrayGroupBy.mean 813 DataArrayGroupBy.median 814 DataArrayGroupBy.min 815 DataArrayGroupBy.prod 816 DataArrayGroupBy.std 817 DataArrayGroupBy.sum 818 DataArrayGroupBy.var 819 DataArrayGroupBy.dims 820 DataArrayGroupBy.groups 821 822 823Rolling objects 824=============== 825 826.. currentmodule:: xarray.core.rolling 827 828Dataset 829------- 830 831.. autosummary:: 832 :toctree: generated/ 833 834 DatasetRolling 835 DatasetRolling.construct 836 DatasetRolling.reduce 837 DatasetRolling.argmax 838 DatasetRolling.argmin 839 DatasetRolling.count 840 DatasetRolling.max 841 DatasetRolling.mean 842 DatasetRolling.median 843 DatasetRolling.min 844 DatasetRolling.prod 845 DatasetRolling.std 846 DatasetRolling.sum 847 DatasetRolling.var 848 849DataArray 850--------- 851 852.. autosummary:: 853 :toctree: generated/ 854 855 DataArrayRolling 856 DataArrayRolling.construct 857 DataArrayRolling.reduce 858 DataArrayRolling.argmax 859 DataArrayRolling.argmin 860 DataArrayRolling.count 861 DataArrayRolling.max 862 DataArrayRolling.mean 863 DataArrayRolling.median 864 DataArrayRolling.min 865 DataArrayRolling.prod 866 DataArrayRolling.std 867 DataArrayRolling.sum 868 DataArrayRolling.var 869 870Coarsen objects 871=============== 872 873Dataset 874------- 875 876.. autosummary:: 877 :toctree: generated/ 878 879 DatasetCoarsen 880 DatasetCoarsen.all 881 DatasetCoarsen.any 882 DatasetCoarsen.construct 883 DatasetCoarsen.count 884 DatasetCoarsen.max 885 DatasetCoarsen.mean 886 DatasetCoarsen.median 887 DatasetCoarsen.min 888 DatasetCoarsen.prod 889 DatasetCoarsen.reduce 890 DatasetCoarsen.std 891 DatasetCoarsen.sum 892 DatasetCoarsen.var 893 894DataArray 895--------- 896 897.. autosummary:: 898 :toctree: generated/ 899 900 DataArrayCoarsen 901 DataArrayCoarsen.all 902 DataArrayCoarsen.any 903 DataArrayCoarsen.construct 904 DataArrayCoarsen.count 905 DataArrayCoarsen.max 906 DataArrayCoarsen.mean 907 DataArrayCoarsen.median 908 DataArrayCoarsen.min 909 DataArrayCoarsen.prod 910 DataArrayCoarsen.reduce 911 DataArrayCoarsen.std 912 DataArrayCoarsen.sum 913 DataArrayCoarsen.var 914 915Exponential rolling objects 916=========================== 917 918.. currentmodule:: xarray.core.rolling_exp 919 920.. autosummary:: 921 :toctree: generated/ 922 923 RollingExp 924 RollingExp.mean 925 RollingExp.sum 926 927Weighted objects 928================ 929 930.. currentmodule:: xarray.core.weighted 931 932Dataset 933------- 934 935.. autosummary:: 936 :toctree: generated/ 937 938 DatasetWeighted 939 DatasetWeighted.mean 940 DatasetWeighted.sum 941 DatasetWeighted.std 942 DatasetWeighted.var 943 DatasetWeighted.sum_of_weights 944 DatasetWeighted.sum_of_squares 945 946DataArray 947--------- 948 949.. autosummary:: 950 :toctree: generated/ 951 952 DataArrayWeighted 953 DataArrayWeighted.mean 954 DataArrayWeighted.sum 955 DataArrayWeighted.std 956 DataArrayWeighted.var 957 DataArrayWeighted.sum_of_weights 958 DataArrayWeighted.sum_of_squares 959 960Resample objects 961================ 962 963.. currentmodule:: xarray.core.resample 964 965Dataset 966------- 967 968.. autosummary:: 969 :toctree: generated/ 970 971 DatasetResample 972 DatasetResample.asfreq 973 DatasetResample.backfill 974 DatasetResample.interpolate 975 DatasetResample.nearest 976 DatasetResample.pad 977 DatasetResample.all 978 DatasetResample.any 979 DatasetResample.apply 980 DatasetResample.assign 981 DatasetResample.assign_coords 982 DatasetResample.bfill 983 DatasetResample.count 984 DatasetResample.ffill 985 DatasetResample.fillna 986 DatasetResample.first 987 DatasetResample.last 988 DatasetResample.map 989 DatasetResample.max 990 DatasetResample.mean 991 DatasetResample.median 992 DatasetResample.min 993 DatasetResample.prod 994 DatasetResample.quantile 995 DatasetResample.reduce 996 DatasetResample.std 997 DatasetResample.sum 998 DatasetResample.var 999 DatasetResample.where 1000 DatasetResample.dims 1001 DatasetResample.groups 1002 1003 1004DataArray 1005--------- 1006 1007.. autosummary:: 1008 :toctree: generated/ 1009 1010 DataArrayResample 1011 DataArrayResample.asfreq 1012 DataArrayResample.backfill 1013 DataArrayResample.interpolate 1014 DataArrayResample.nearest 1015 DataArrayResample.pad 1016 DataArrayResample.all 1017 DataArrayResample.any 1018 DataArrayResample.apply 1019 DataArrayResample.assign_coords 1020 DataArrayResample.bfill 1021 DataArrayResample.count 1022 DataArrayResample.ffill 1023 DataArrayResample.fillna 1024 DataArrayResample.first 1025 DataArrayResample.last 1026 DataArrayResample.map 1027 DataArrayResample.max 1028 DataArrayResample.mean 1029 DataArrayResample.median 1030 DataArrayResample.min 1031 DataArrayResample.prod 1032 DataArrayResample.quantile 1033 DataArrayResample.reduce 1034 DataArrayResample.std 1035 DataArrayResample.sum 1036 DataArrayResample.var 1037 DataArrayResample.where 1038 DataArrayResample.dims 1039 DataArrayResample.groups 1040 1041Accessors 1042========= 1043 1044.. currentmodule:: xarray 1045 1046.. autosummary:: 1047 :toctree: generated/ 1048 1049 core.accessor_dt.DatetimeAccessor 1050 core.accessor_dt.TimedeltaAccessor 1051 core.accessor_str.StringAccessor 1052 1053Custom Indexes 1054============== 1055.. autosummary:: 1056 :toctree: generated/ 1057 1058 CFTimeIndex 1059 1060Creating custom indexes 1061----------------------- 1062.. autosummary:: 1063 :toctree: generated/ 1064 1065 cftime_range 1066 1067Faceting 1068-------- 1069.. autosummary:: 1070 :toctree: generated/ 1071 1072 plot.FacetGrid 1073 plot.FacetGrid.add_colorbar 1074 plot.FacetGrid.add_legend 1075 plot.FacetGrid.add_quiverkey 1076 plot.FacetGrid.map 1077 plot.FacetGrid.map_dataarray 1078 plot.FacetGrid.map_dataarray_line 1079 plot.FacetGrid.map_dataset 1080 plot.FacetGrid.set_axis_labels 1081 plot.FacetGrid.set_ticks 1082 plot.FacetGrid.set_titles 1083 plot.FacetGrid.set_xlabels 1084 plot.FacetGrid.set_ylabels 1085 1086Tutorial 1087======== 1088 1089.. autosummary:: 1090 :toctree: generated/ 1091 1092 tutorial.open_dataset 1093 tutorial.open_rasterio 1094 tutorial.load_dataset 1095 1096Testing 1097======= 1098 1099.. autosummary:: 1100 :toctree: generated/ 1101 1102 testing.assert_equal 1103 testing.assert_identical 1104 testing.assert_allclose 1105 testing.assert_chunks_equal 1106 1107Exceptions 1108========== 1109 1110.. autosummary:: 1111 :toctree: generated/ 1112 1113 MergeError 1114 SerializationWarning 1115 1116Advanced API 1117============ 1118 1119.. autosummary:: 1120 :toctree: generated/ 1121 1122 Dataset.variables 1123 DataArray.variable 1124 Variable 1125 IndexVariable 1126 as_variable 1127 Context 1128 register_dataset_accessor 1129 register_dataarray_accessor 1130 Dataset.set_close 1131 backends.BackendArray 1132 backends.BackendEntrypoint 1133 1134These backends provide a low-level interface for lazily loading data from 1135external file-formats or protocols, and can be manually invoked to create 1136arguments for the ``load_store`` and ``dump_to_store`` Dataset methods: 1137 1138.. autosummary:: 1139 :toctree: generated/ 1140 1141 backends.NetCDF4DataStore 1142 backends.H5NetCDFStore 1143 backends.PydapDataStore 1144 backends.ScipyDataStore 1145 backends.FileManager 1146 backends.CachingFileManager 1147 backends.DummyFileManager 1148 1149Deprecated / Pending Deprecation 1150================================ 1151 1152.. autosummary:: 1153 :toctree: generated/ 1154 1155 Dataset.drop 1156 DataArray.drop 1157 Dataset.apply 1158 core.groupby.DataArrayGroupBy.apply 1159 core.groupby.DatasetGroupBy.apply 1160 1161.. autosummary:: 1162 :toctree: generated/ 1163 :template: autosummary/accessor_attribute.rst 1164 1165 DataArray.dt.weekofyear 1166 DataArray.dt.week 1167