|
621 | 621 | True, or a tuple of both if *item* is True.""",
|
622 | 622 | # regrid RegridOperator
|
623 | 623 | "{{regrid RegridOperator}}": """* `RegridOperator`: The grid is defined by a regrid
|
624 |
| - operator that has been returned by a previous call |
625 |
| - with the *return_operator* parameter set to True. |
626 |
| -
|
627 |
| - Unlike the other options, for which the regrid weights |
628 |
| - need to be calculated, the regrid operator already |
629 |
| - contains the weights. Therefore, for cases where |
630 |
| - multiple fields with the same source grids need to be |
631 |
| - regridded to the same destination grid, using a regrid |
632 |
| - operator can give performance improvements by avoiding |
633 |
| - having to calculate the weights for each source |
634 |
| - field. Note that for the other types of *dst* |
635 |
| - parameter, the calculation of the regrid weights is |
636 |
| - not a lazy operation. |
637 |
| -
|
638 |
| - .. note:: The source grid of the regrid operator is |
639 |
| - immediately checked for compatibility with |
640 |
| - the grid of the source field. By default |
641 |
| - only the computationally cheap tests are |
642 |
| - performed (checking that the coordinate |
643 |
| - system, cyclicity and grid shape are the |
644 |
| - same), with the grid coordinates not being |
645 |
| - checked. The coordinates check will be |
646 |
| - carried out, however, if the |
647 |
| - *check_coordinates* parameter is True.""", |
| 624 | + operator that has been returned by a previous call |
| 625 | + with the *return_operator* parameter set to True. |
| 626 | +
|
| 627 | + Unlike the other options, for which the regrid |
| 628 | + weights need to be calculated, the regrid operator |
| 629 | + already contains the weights. Therefore, for cases |
| 630 | + where multiple fields with the same source grids |
| 631 | + need to be regridded to the same destination grid, |
| 632 | + using a regrid operator can give performance |
| 633 | + improvements by avoiding having to calculate the |
| 634 | + weights for each source field. Note that for the |
| 635 | + other types of *dst* parameter, the calculation of |
| 636 | + the regrid weights is not a lazy operation. |
| 637 | +
|
| 638 | + .. note:: When *dst* is a `RegridOperator`, the |
| 639 | + source grid of the regrid operator is |
| 640 | + immediately checked for compatibility with |
| 641 | + the grid of the source field. By default |
| 642 | + only the computationally cheap tests are |
| 643 | + performed (checking that the coordinate |
| 644 | + system, cyclicity, grid shape, regridding |
| 645 | + dimesionality, mesh location, and feature |
| 646 | + type are the same), with the grid |
| 647 | + coordinates not being checked. The |
| 648 | + coordinates check will be carried out, |
| 649 | + however, if the *check_coordinates* |
| 650 | + parameter is True.""", |
648 | 651 | # Returns cfa_file_substitutions
|
649 | 652 | "{{Returns cfa_file_substitutions}}": """The CFA-netCDF file name substitutions in a dictionary
|
650 | 653 | whose key/value pairs are the file name parts to be
|
|
0 commit comments