/usr/bin/ncremap is in nco 4.7.2-1.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 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 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 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 | #!/bin/bash
# Purpose: Regrid (subsets of) netCDF files between different Swath, Curvilinear, Rectangular, and Unstructured data (SCRUD) grids, generate any required/requested global or regional rectangular grid, output SCRIP, UGRID, and/or skeleton data formats
# Copyright (C) 2015--2018 Charlie Zender
# This file is part of NCO, the netCDF Operators. NCO is free software.
# You may redistribute and/or modify NCO under the terms of the
# GNU General Public License (GPL) Version 3.
# As a special exception to the terms of the GPL, you are permitted
# to link the NCO source code with the HDF, netCDF, OPeNDAP, and UDUnits
# libraries and to distribute the resulting executables under the terms
# of the GPL, but in addition obeying the extra stipulations of the
# HDF, netCDF, OPeNDAP, and UDUnits licenses.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU General Public License for more details.
# The original author of this software, Charlie Zender, seeks to improve
# it with your suggestions, contributions, bug-reports, and patches.
# Please contact the NCO project at http://nco.sf.net or write to
# Charlie Zender
# Department of Earth System Science
# University of California, Irvine
# Irvine, CA 92697-3100
# Prerequisites: Bash, NCO
# Script could use other shells, e.g., dash (Debian default) after rewriting function definition and looping constructs
# For full functionality also install ESMF_RegridWeightGen and/or TempestRemap
# Source: https://github.com/nco/nco/tree/master/data/ncremap
# Documentation: http://nco.sf.net/nco.html#ncremap
# Additional Documentation:
# HowTo: https://acme-climate.atlassian.net/wiki/display/SIM/Generate%2C+Regrid%2C+and+Split+Climatologies+%28climo+files%29+with+ncclimo+and+ncremap
# E3SM/ACME Climatology Requirements: https://acme-climate.atlassian.net/wiki/display/ATM/Climo+Files+-+v0.3+AMIP+runs
# Regridder works in one of four modes:
# 1. Free-will: Infer source and destination grids to generate map-file, then regrid
# 2. Old Grid: Use known-good destination grid to generate map-file then regrid
# 3. New Grid: Generate source-grid from ncks parameter string
# 4. Pre-Destination: Apply supplied map-file to all input files
# By default, ncremap deletes any intermediate grids and map-file that it generates
# Use Free-Will, Old-Grid, or New-Grid mode to process Swath-Like-Data (SLD) where each input may be a granule on a new grid, yet all inputs are to be regridded to the same output grid
# Use Pre-Destination mode to post-process models or analyses where all files are converted from the same source grid to the same destination grid so the map-file can be pre-generated and never change
# Insta-install:
# scp ~/nco/data/ncremap aims4.llnl.gov:bin
# scp ~/nco/data/ncremap blues.lcrc.anl.gov:bin
# scp ~/nco/data/ncremap cheyenne.ucar.edu:bin
# scp ~/nco/data/ncremap cooley.alcf.anl.gov:bin
# scp ~/nco/data/ncremap cori.nersc.gov:bin_cori
# scp ~/nco/data/ncremap edison.nersc.gov:bin_edison
# scp ~/nco/data/ncremap rhea.ccs.ornl.gov:bin_rhea
# scp ~/nco/data/ncremap skyglow.ess.uci.edu:bin
# scp dust.ess.uci.edu:nco/data/ncremap ~/bin
# Set script name, directory, PID, run directory
drc_pwd=${PWD}
# Set these before 'module' command which can overwrite ${BASH_SOURCE[0]}
# NB: dash supports $0 syntax, not ${BASH_SOURCE[0]} syntax
# http://stackoverflow.com/questions/59895/can-a-bash-script-tell-what-directory-its-stored-in
spt_src="${BASH_SOURCE[0]}"
[[ -z "${spt_src}" ]] && spt_src="${0}" # Use ${0} when BASH_SOURCE is unavailable (e.g., dash)
while [ -h "${spt_src}" ]; do # Recursively resolve ${spt_src} until file is no longer a symlink
drc_spt="$( cd -P "$( dirname "${spt_src}" )" && pwd )"
spt_src="$(readlink "${spt_src}")"
[[ ${spt_src} != /* ]] && spt_src="${drc_spt}/${spt_src}" # If ${spt_src} was relative symlink, resolve it relative to path where symlink file was located
done
cmd_ln="${spt_src} ${@}"
drc_spt="$( cd -P "$( dirname "${spt_src}" )" && pwd )"
spt_nm=$(basename ${spt_src}) # [sng] Script name (unlike $0, ${BASH_SOURCE[0]} works well with 'source <script>')
spt_pid=$$ # [nbr] Script PID (process ID)
# Configure paths at High-Performance Computer Centers (HPCCs) based on ${HOSTNAME}
if [ -z "${HOSTNAME}" ]; then
if [ -f /bin/hostname ] && [ -x /bin/hostname ]; then
export HOSTNAME=`/bin/hostname`
elif [ -f /usr/bin/hostname ] && [ -x /usr/bin/hostname ]; then
export HOSTNAME=`/usr/bin/hostname`
fi # !hostname
fi # HOSTNAME
# Default input and output directory is ${DATA}
if [ -z "${DATA}" ]; then
case "${HOSTNAME}" in
constance* | node* ) DATA='/scratch' ; ;; # PNNL
blues* | blogin* | b[0123456789][0123456789][0123456789] ) DATA="/lcrc/project/ACME/${USER}" ; ;; # ALCF blues compute nodes named bNNN, 36|64 cores|GB/node
*cheyenne* ) DATA="/glade/p/work/${USER}" ; ;; # NCAR cheyenne compute nodes named cheyenneNNN, 18|(64/128) cores|GB/node (cheyenne login nodes 256 GB)
cooley* | cc[0123456789][0123456789][0123456789] | mira* ) DATA="/projects/HiRes_EarthSys/${USER}" ; ;; # ALCF cooley compute nodes named ccNNN, 384 GB/node
cori* | edison* ) DATA="${SCRATCH}" ; ;; # NERSC cori/edison compute nodes all named nidNNNNN, edison 24|64 cores|GB/node; cori 32|(96/128) cores|GB/node (knl/haswell) (cori login nodes 512 GB)
pileus* ) DATA="/lustre/atlas/world-shared/cli115/${USER}" ; ;; # OLCF CADES
rhea* | titan* ) DATA="/lustre/atlas/world-shared/cli115/${USER}" ; ;; # OLCF rhea compute nodes named rheaNNN, 128 GB/node
* ) DATA='/tmp' ; ;; # Other
esac # !HOSTNAME
fi # DATA
# Ensure batch jobs access correct 'mpirun' (or, with SLURM, 'srun') command, netCDF library, and NCO executables and library
# 20170914 Entire block is identical between ncclimo and ncremap---keep it that way!
# hrd_pth is a placeholder no-op that could be a command-line option to control environment
# Set NCO_PATH_OVERRIDE to 'No' to prevent NCO from executing next block that overrides PATH:
# export NCO_PATH_OVERRIDE='No'
hrd_pth='Yes' # [sng] Hard-code machine-dependent paths/modules if HOSTNAME in database
if [ "${hrd_pth}" != 'No' ] && [ "${NCO_PATH_OVERRIDE}" != 'No' ]; then
# If HOSTNAME is not in database, change hrd_pth_fnd to 'No' in case-statement default fall-through
hrd_pth_fnd='Yes' # [sng] Machine-dependent paths/modules for HOSTNAME found in database
case "${HOSTNAME}" in
aims* )
export PATH='/export/zender1/bin'\:${PATH}
export LD_LIBRARY_PATH='/export/zender1/lib'\:${LD_LIBRARY_PATH} ; ;;
blues* | blogin* | b[0123456789][0123456789][0123456789] )
soft add @openmpi-gcc
export PATH='/home/zender/bin'\:${PATH}
export LD_LIBRARY_PATH='/home/zender/lib'\:${LD_LIBRARY_PATH} ; ;;
cooley* )
# 20160421: Split cooley from mira binary locations to allow for different system libraries
# http://www.mcs.anl.gov/hs/software/systems/softenv/softenv-intro.html
soft add +mvapich2
export PBS_NUM_PPN=12 # Spoof PBS on Soft (which knows nothing about node capabilities)
export PATH='/home/zender/bin_cooley'\:${PATH}
export LD_LIBRARY_PATH='/home/zender/lib_cooley'\:${LD_LIBRARY_PATH} ; ;;
mira* )
export PATH='/home/zender/bin_mira'\:${PATH}
export LD_LIBRARY_PATH='/soft/libraries/netcdf/current/library:/home/zender/lib_mira'\:${LD_LIBRARY_PATH} ; ;;
*cheyenne* )
# 20180112: Cheyenne support not yet tested in batch mode
if [ ${spt_nm} = 'ncremap' ]; then
# On cheyenne, module load ncl installs ERWG in /glade/u/apps/ch/opt/ncl/6.4.0/intel/17.0.1/bin (i.e., ${NCARG_ROOT}/bin)
module load ncl
fi # !ncremap
if [ -n "${NCARG_ROOT}" ]; then
export PATH="${PATH}:/glade/u/apps/ch/opt/ncl/6.4.0/intel/17.0.1/bin"
fi # !NCARG_ROOT
export PATH='/glade/u/home/zender/bin'\:${PATH}
export LD_LIBRARY_PATH='/glade/u/apps/ch/opt/netcdf/4.4.1.1/intel/17.0.1/lib:/glade/u/home/zender/lib'\:${LD_LIBRARY_PATH} ; ;;
cori* )
# 20160407: Separate cori from edison binary locations to allow for different system libraries
# 20160420: module load gsl, udunits required for non-interactive batch submissions by Wuyin Lin
# Not necessary for interactive, nor for CSZ non-interactive, batch submisssions
# Must be due to home environment differences between CSZ and other users
# Loading gsl and udunits seems to do no harm, so always do it
# This is equivalent to LD_LIBRARY_PATH method used for netCDF and SZIP on rhea
# Why do cori/edison and rhea require workarounds for different packages?
module load gsl
module load udunits
if [ ${spt_nm} = 'ncremap' ]; then
module load ncl # 20170916 OK
fi # !ncremap
if [ -n "${NCARG_ROOT}" ]; then
export PATH="${PATH}:${NCARG_ROOT}/bin"
fi # !NCARG_ROOT
export PATH='/global/homes/z/zender/bin_cori'\:${PATH}
export LD_LIBRARY_PATH='/global/homes/z/zender/lib_cori'\:${LD_LIBRARY_PATH} ; ;;
edison* )
module load gsl
module load udunits2 # 20170816 Name changed to udunits2
if [ ${spt_nm} = 'ncremap' ]; then
module load ncl # 20170916 OK
fi # !ncremap
if [ -n "${NCARG_ROOT}" ]; then
export PATH="${PATH}:${NCARG_ROOT}/bin"
fi # !NCARG_ROOT
export PATH='/global/homes/z/zender/bin_edison'\:${PATH}
export LD_LIBRARY_PATH='/global/homes/z/zender/lib_edison'\:${LD_LIBRARY_PATH} ; ;;
pileus* )
export PATH='/home/zender/bin'\:${PATH}
export LD_LIBRARY_PATH='/opt/ACME/uvcdat-2.2-build/install/Externals/lib:/home/zender/lib'\:${LD_LIBRARY_PATH} ; ;;
rhea* )
# 20151017: CSZ next three lines guarantee finding mpirun
source ${MODULESHOME}/init/sh # 20150607: PMC Ensures find module commands will be found
module unload PE-intel # Remove Intel-compiled mpirun environment
module load PE-gnu # Provides GCC-compiled mpirun environment (CSZ uses GCC to build NCO on rhea)
# 20160219: CSZ UVCDAT setup causes failures with mpirun, attempting a work-around
if [ -n "${UVCDAT_SETUP_PATH}" ]; then
module unload python ompi paraview PE-intel PE-gnu
module load gcc
source /lustre/atlas1/cli900/world-shared/sw/rhea/uvcdat/latest_full/bin/setup_runtime.sh
export ${UVCDAT_SETUP_PATH}
fi # !UVCDAT_SETUP_PATH
if [ ${spt_nm} = 'ncremap' ]; then
# 20170825: Use module load ncl/6.3.0 (6.4.0 lacks ERWG)
module load ncl/6.3.0
fi # !ncremap
if [ -n "${NCARG_ROOT}" ]; then
export PATH="${PATH}:${NCARG_ROOT}/bin"
fi # !NCARG_ROOT
export PATH='/ccs/home/zender/bin_rhea'\:${PATH}
export LD_LIBRARY_PATH='/autofs/nccs-svm1_sw/rhea/.swci/0-core/opt/spack/20170224/linux-rhel6-x86_64/gcc-4.4.7/netcdf-4.4.1-uroyzcwi6fc3kerfidguoof7g2vimo57/lib:/sw/redhat6/szip/2.1/rhel6.6_gnu4.8.2/lib:/ccs/home/zender/lib_rhea'\:${LD_LIBRARY_PATH} ; ;;
titan* )
source ${MODULESHOME}/init/sh # 20150607: PMC Ensures find module commands will be found
module load gcc
if [ ${spt_nm} = 'ncremap' ]; then
# 20170831: Use module load ncl (6.3.0 lacks ERWG)
module load ncl # 20170916 OK
fi # !ncremap
if [ -n "${NCARG_ROOT}" ]; then
export PATH="${PATH}:${NCARG_ROOT}/bin"
fi # !NCARG_ROOT
export PATH='/ccs/home/zender/bin_titan'\:${PATH}
export LD_LIBRARY_PATH='/opt/cray/netcdf/4.4.1.1/GNU/49/lib:/sw/xk6/udunits/2.1.24/sl_gcc4.5.3/lib:/ccs/home/zender/lib_titan'\:${LD_LIBRARY_PATH} ; ;;
* ) # Default fall-through
hrd_pth_fnd='No' ; ;;
esac # !HOSTNAME
fi # !hrd_pth && !NCO_PATH_OVERRIDE
# Test cases (for Charlie's machines)
# Map-only:
# ncremap -s ${DATA}/grids/oEC60to30.SCRIP.150729.nc -g ${DATA}/grids/t62_SCRIP.20150901.nc -m ~/map.nc -a bilinear
# ncremap -s ${DATA}/grids/oEC60to30.SCRIP.150729.nc -g ${DATA}/grids/t62_SCRIP.20150901.nc -m ~/map.nc -a tempest
# ncremap -s ${DATA}/grids/oEC60to30.SCRIP.150729.nc -d ${DATA}/dstmch90/dstmch90_clm.nc -m ~/map.nc -a tempest
# ncremap -s ${DATA}/grids/128x256_SCRIP.20160301.nc -d ${DATA}/dstmch90/dstmch90_clm.nc -m ~/map.nc -a tempest
# Regrid:
# ls ${DATA}/ne30/raw/*1979*.nc | ncremap -m ${DATA}/maps/map_ne30np4_to_fv129x256_aave.20150901.nc -O ~/rgr
# ncremap -a conserve -v FSNT -I ${DATA}/ne30/raw -s ${DATA}/grids/ne30np4_pentagons.091226.nc -d ${DATA}/dstmch90/dstmch90_clm.nc -O ~/rgr
# ls ${DATA}/essgcm14/essgcm14*cam*0007*.nc | ncremap -a conserve -M -d ${DATA}/dstmch90/dstmch90_clm.nc -O ~/rgr
# ncremap -a conserve -v FSNT -I ${DATA}/ne30/raw -s ${DATA}/grids/ne30np4_pentagons.091226.nc -d ${DATA}/dstmch90/dstmch90_clm.nc -O ~/rgr
# ncremap -i ${DATA}/hdf/AIRS.2014.10.01.202.L2.TSurfStd.Regrid010.1DLatLon.hole.nc -d ${DATA}/dstmch90/dstmch90_clm.nc -O ~/rgr
# ncremap -v TSurfAir -i ${DATA}/hdf/AIRS.2015.01.15.001.L2.RetStd.v6.0.11.0.G15015142014.hdf -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -v CloudFrc_A -i ${DATA}/hdf/AIRS.2002.08.01.L3.RetStd_H031.v4.0.21.0.G06104133732.hdf -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -i ${DATA}/hdf/MOD04_L2.A2000055.0005.006.2014307165927.hdf -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -i ${DATA}/hdf/OMI-Aura_L2-OMIAuraSO2_2012m1222-o44888_v01-00-2014m0107t114720.h5 -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -v T -i ${DATA}/hdf/wrfout_v2_Lambert_notime.nc -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -v StepTwoO3 -i ${DATA}/hdf/OMI-Aura_L2-OMTO3_2015m0731t0034-o58727_v003-2015m0731t080836.he5.nc -d ${DATA}/hdf/cam_time.nc -O ~/rgr
# ncremap -v TSurfStd -i ${DATA}/sld/raw/AIRS.2014.10.01.202.L2.TSurfStd.Regrid010.1DLatLon.hole.nc -G "--rgr grd_ttl='Default internally-generated grid' --rgr grid=~/rgr/ncremap_tmp_grd_dst.nc --rgr latlon=100,100 --rgr snwe=30.0,70.0,-130.0,-90.0" -O ~/rgr
# ncremap -x TSurfStd_ct -i ${DATA}/sld/raw/AIRS.2014.10.01.202.L2.TSurfStd.Regrid010.1DLatLon.hole.nc -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -i ${DATA}/hdf/cice_hi_flt.nc -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -i ${DATA}/hdf/cam_time.nc -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# CESM & E3SM/ACME:
# ncremap -s ${DATA}/grids/ne120np4_pentagons.100310.nc -i ${DATA}/ne120/raw/b1850c5_m2a.cam.h0.0060-01.nc -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -s ${DATA}/grids/ne120np4_pentagons.100310.nc -i ${DATA}/ne120/raw/b1850c5_m2a.clm2.h0.0060-01.nc -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -i ${DATA}/ne120/raw/b1850c5_m2a.cice.h.0060-01.nc -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -i ${DATA}/ne120/raw/b1850c5_m2a.pop.h.0060-01.nc -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# ncremap -i ${DATA}/ne120/raw/b1850c5_m2a.rtm.h0.0060-01.nc -g ${DATA}/grids/180x360_SCRIP.20150901.nc -O ~/rgr
# Old MPAS filename conventions (until ~201609)::
# ncremap -P mpas -i ${DATA}/hdf/hist.ocn.0003-12-01_00.00.00.nc -m ${DATA}/maps/map_oEC60to30_to_t62_bilin.20160301.nc -O ~/rgr
# ncremap -P mpas -i ${DATA}/hdf/hist.ice.0003-12-01_00.00.00.nc -m ${DATA}/maps/map_mpas120_TO_T62_aave.121116.nc -O ~/rgr
# New MPAS filename conventions (as of ~201612):
# ncremap -P mpas -i ${DATA}/hdf/mpaso.hist.am.timeSeriesStatsMonthly.0001-01-01.nc -m ${DATA}/maps/map_oEC60to30_to_t62_bilin.20160301.nc -O ~/rgr
# ncremap -P mpas -i ${DATA}/hdf/mpascice.hist.am.timeSeriesStatsMonthly.0251-01-01.nc -m ${DATA}/maps/map_oEC60to30_to_t62_bilin.20160301.nc -O ~/rgr
# ncremap -P mpas --mss_val=-1.0e36 -s ${DATA}/grids/ais20km.150910.SCRIP.nc -i ${DATA}/hdf/ais20km.20180117.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -o ~/foo.nc
# E3SM/ACME benchmarks:
# ncremap -v FSNT,AODVIS -i ${DATA}/ne30/raw/famipc5_ne30_v0.3_00003.cam.h0.1979-01.nc -m ${DATA}/maps/map_ne30np4_to_fv129x256_aave.20150901.nc -o ~/foo.nc
# ncremap -v FSNT,AODVIS -a conserve -i ${DATA}/ne30/raw/famipc5_ne30_v0.3_00003.cam.h0.1979-01.nc -s ${DATA}/grids/ne30np4_pentagons.091226.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -o ~/foo.nc
# ncremap -v FSNT,AODVIS -a tempest -i ${DATA}/ne30/raw/famipc5_ne30_v0.3_00003.cam.h0.1979-01.nc -s ${DATA}/grids/ne30np4_pentagons.091226.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -o ~/foo.nc
# Positional arguments:
# ncremap --var=FSNT,AODVIS --map=${DATA}/maps/map_ne30np4_to_fv129x256_aave.20150901.nc --drc_out=~/rgr ${DATA}/ne30/raw/famipc5_ne30_v0.3_00003.cam.h0.1979-??.nc
# Omit cell_measures:
# ncremap --no_cll_msr --var=FSNT,AODVIS -i ${DATA}/ne30/raw/famipc5_ne30_v0.3_00003.cam.h0.1979-01.nc -m ${DATA}/maps/map_ne30np4_to_fv129x256_aave.20150901.nc -o ~/foo.nc
# SGS (201705):
# ncremap --vrb=3 -P sgs --var=area,FSDS,landfrac,landmask,TBOT -i ${DATA}/ne30/raw/F_acmev03_enso_camse_clm45bgc_ne30_co2cycle.clm2.h0.2000-01.nc -s ${DATA}/grids/ne30np4_pentagons.091226.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -o ~/alm_rgr.nc # 20170510 1D->2D works conserve and bilinear, no inferral
# ncremap --vrb=3 -P sgs --var=area,FSDS,landfrac,landmask,TBOT -i ${DATA}/essgcm14/essgcm14.clm2.h0.0000-01.nc -s ${DATA}/grids/t42_SCRIP.20150901.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -o ~/t42_rgr.nc # 20170510 2D->2D works conserve and bilinear, no inferral
# ncremap --vrb=3 -P sgs --var=area,FSDS,landfrac,landmask,TBOT -i ${DATA}/essgcm14/essgcm14.clm2.h0.0000-01.nc -s ${DATA}/grids/t42_SCRIP.20150901.nc -d ${DATA}/dstmch90/dstmch90_clm.nc -o ~/t42_rgr.nc # 20170510 2D->2D works bilinear and conserve, infer D not S
# ncremap --vrb=3 -P sgs --var=area,FSDS,landfrac,landmask,TBOT -i ${DATA}/essgcm14/essgcm14.clm2.h0.0000-01.nc -d ${DATA}/dstmch90/dstmch90_clm.nc -o ~/t42_rgr.nc # 20170510 2D->2D works bilinear and conserve ~2% wrong, infer S and D
# ncremap --vrb=3 -P sgs --var=area,FSDS,landfrac,landmask,TBOT -i ${DATA}/essgcm14/essgcm14.clm2.h0.0000-01.nc -d ${DATA}/hdf/b1850c5cn_doe_polar_merged_0_cesm1_2_0_HD+MAM4+tun2b.hp.e003.cam.h0.0001-01.nc -o ~/t42_rgr.nc # 20170510 2D->2D works bilinear and conserve ~2% wrong, infer S and D
# ncremap --vrb=3 -P sgs --var=area,FSDS,landfrac,landmask,TBOT -i ${DATA}/ne30/rgr/F_acmev03_enso_camse_clm45bgc_ne30_co2cycle.clm2.h0.2000-01.nc -d ${DATA}/essgcm14/essgcm14.cam2.h0.0000-01.nc -o ~/fv09_rgr.nc # 20170510 2D->2D bilinear works and conserve ~2% wrong, infer S and D
# ncremap --vrb=3 -P sgs --var=area,FSDS,landfrac,landmask,TBOT -i ${DATA}/ne30/rgr/F_acmev03_enso_camse_clm45bgc_ne30_co2cycle.clm2.h0.2000-01.nc -d ${HOME}/skl_t42.nc -o ~/fv09_rgr.nc # 20170510 2D->2D works bilinear and conserve ~2% wrong, infer S and D
# ncremap --vrb=3 -p nil -P sgs -s ${DATA}/grids/ne30np4_pentagons.091226.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -O ${DATA}/ne30/rgr ${DATA}/ne30/raw/F_acmev03_enso_camse_clm45bgc_ne30_co2cycle.clm2.h0.2000-??.nc > ~/ncremap.out 2>&1 &
# ncremap --vrb=3 -a conserve --sgs_frc=aice --sgs_msk=tmask --sgs_nrm=100 --var=hi,uvel,aice,aisnap,albsno,blkmask,evap,evap_ai,fswabs,fswabs_ai,fswdn,fswthru,fswthru_ai,ice_present,snow,snow_ai,tarea,tmask,uarea -i ${DATA}/hdf/ctl_brcp85c5cn_deg1.enm.cice.h.2050-07.nc -s ${DATA}/grids/gx1v7_151008.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -o ~/cice_rgr.nc # 20170525 normalization required to get mask right
# ncremap --vrb=3 -P cice -a conserve --var=hi,uvel,aice,aisnap,albsno,blkmask,evap,evap_ai,fswabs,fswabs_ai,fswdn,fswthru,fswthru_ai,ice_present,snow,snow_ai,tarea,tmask,uarea -i ${DATA}/hdf/ctl_brcp85c5cn_deg1.enm.cice.h.2050-07.nc -s ${DATA}/grids/gx1v7_151008.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -o ~/cice_rgr.nc # 20170525 cice short-cut
# CICE/CESM on POP grid: full grid inferral (and thus conservative remapping) fails because masked vertices/cells missing, must use bilinear or supply grid-file for conservative
# ncremap -a bilinear -i ${DATA}/hdf/ctl_brcp85c5cn_deg1.enm.cice.h.2050-07.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -o ~/wenshan.nc # 20170515: grid centers/bounds in non-masked regions suffice for bilinear interpolation
# ncremap -a conserve -i ${DATA}/hdf/ctl_brcp85c5cn_deg1.enm.cice.h.2050-07.nc -s ${DATA}/grids/gx1v7_151008.nc -g ${DATA}/grids/129x256_SCRIP.20150901.nc -o ~/wenshan.nc # 20170521: conservative requires supplied tri-pole grid for centers/bounds in masked regions
# File-format
# ncremap -v FSNT,AODVIS -s ${DATA}/grids/ne30np4_pentagons.091226.nc -i ${DATA}/ne30/raw/famipc5_ne30_v0.3_00003.cam.h0.1979-01.nc -d ${DATA}/dstmch90/dstmch90_clm.nc -o ~/foo.nc
# TempestRemap boutique:
# GenerateCSMesh --alt --res 30 --file ${DATA}/grids/ne30.g
# ncremap --dbg=1 -a se2fv_flx --src_grd=${DATA}/grids/ne30.g --dst_grd=${DATA}/grids/129x256_SCRIP.20150901.nc -m ~/map_ne30np4_to_fv129x256_mono.20180101.nc
# ncremap --dbg=1 -i ${DATA}/ne30/raw/famipc5_ne30_v0.3_00003.cam.h0.1979-01.nc -m ~/map_ne30np4_to_fv129x256_mono.20180301.nc -o ~/foo_fv129x256.nc
# ncremap --dbg=1 -a fv2se_stt --src_grd=${DATA}/grids/129x256_SCRIP.20150901.nc --dst_grd=${DATA}/grids/ne30.g -m ~/map_fv129x256_to_ne30np4_highorder.20180301.nc
# ncremap --dbg=1 -i ~/foo_fv129x256.nc -m ~/map_fv129x256_to_ne30np4_highorder.20180301.nc -o ~/foo_ne30.nc
# ncremap --dbg=1 -a se2fv_flx --src_grd=${DATA}/grids/ne30.g --se_mtd=${DATA}/grids/ne30np4_latlon.091226.nc --dst_grd=${DATA}/grids/129x256_SCRIP.20150901.nc -m ~/map_ne30np4_to_fv129x256_mono.20180301.nc
# Debugging and Benchmarking:
# ncremap -D 1 -i ${DATA}/sld/raw/AIRS.2014.10.01.202.L2.TSurfStd.Regrid010.1DLatLon.hole.nc -d ${DATA}/dstmch90/dstmch90_clm.nc -o ~/foo.nc > ~/ncremap.out 2>&1 &
# dbg_lvl: 0 = Quiet, print basic status during evaluation
# 1 = Print configuration, full commands, and status to output during evaluation
# 2 = As in dbg_lvl=1, but DO NOT EXECUTE COMMANDS (i.e., pretend to run but do not regrid anything)
# 3 = As in dbg_lvl=1, and pass debug level through to NCO/ncks
# Set NCO version and directory
nco_exe=`which ncks`
if [ -z "${nco_exe}" ]; then
echo "ERROR: Unable to find NCO, nco_exe = ${nco_exe}"
exit 1
fi # !nco_exe
# StackOverflow method finds NCO directory
while [ -h "${nco_exe}" ]; do
drc_nco="$( cd -P "$( dirname "${nco_exe}" )" && pwd )"
nco_exe="$(readlink "${nco_exe}")"
[[ ${nco_exe} != /* ]] && nco_exe="${drc_nco}/${nco_exe}"
done
drc_nco="$( cd -P "$( dirname "${nco_exe}" )" && pwd )"
nco_vrs=$(ncks --version 2>&1 > /dev/null | grep NCO | awk '{print $5}')
lbr_vrs=$(ncks --library 2>&1 > /dev/null | awk '{print $6}')
# Detect and warn about mixed modules (for Qi Tang 20170531)
if [ "${drc_spt}" != "${drc_nco}" ]; then
echo "WARNING: Possible mixture of NCO versions from different locations. Script ${spt_nm} is from directory ${drc_spt} while NCO binaries are from directory ${drc_nco}. Normally the script and binaries are from the same executables directory. This WARNING may be safely ignored for customized scripts and/or binaries that the user has intentionally split into different directories."
echo "HINT: Conflicting script and binary directories may result from 1) Hardcoding an NCO script and/or binary pathname, 2) Having incomplete NCO installations in one or more directories in the \$PATH environment variable, 3) Loading multiple NCO modules with different locations."
fi # drc_spt
# When running in a terminal window (not in an non-interactive batch queue)...
if [ -n "${TERM}" ]; then
# Set fonts for legibility
if [ -x /usr/bin/tput ] && tput setaf 1 &> /dev/null; then
fnt_bld=`tput bold` # Bold
fnt_nrm=`tput sgr0` # Normal
fnt_rvr=`tput smso` # Reverse
fnt_tlc=`tput sitm` # Italic
else
fnt_bld="\e[1m" # Bold
fnt_nrm="\e[0m" # Normal
fnt_rvr="\e[07m" # Reverse
fnt_tlc="\e[3m" # Italic
fi # !tput
fi # !TERM
# Defaults for command-line options and some derived variables
# Modify these defaults to save typing later
alg_typ='bilinear' # [nbr] Algorithm for remapping (bilinear|conserve|nearestdtos|neareststod|patch|tempest|se2fv_flx|se2fv_stt|se2fv_alt|fv2se_flx|fv2se_stt|fv2se_alt)
bch_pbs='No' # [sng] PBS batch (non-interactive) job
bch_slr='No' # [sng] SLURM batch (non-interactive) job
cln_flg='Yes' # [flg] Clean-up (remove) intermediate files before exiting
clm_flg='No' # [flg] Invoked by ncclimo script
dbg_lvl=0 # [nbr] Debugging level
dfl_lvl=0 # [enm] Deflate level
#drc_in="${drc_pwd}" # [sng] Input file directory
drc_in='' # [sng] Input file directory
drc_in_xmp='~/drc_in' # [sng] Input file directory for examples
drc_out="${drc_pwd}" # [sng] Output file directory
drc_out_xmp="~/rgr" # [sng] Output file directory for examples
dst_fl='' # [sng] Destination file
dst_xmp='dst.nc' # [sng] Destination file for examples
fl_fmt='' # [enm] Output file format
fl_nbr=0 # [nbr] Number of files to remap
gaa_sng="--gaa remap_script=${spt_nm} --gaa remap_command=\"'${cmd_ln}'\" --gaa remap_hostname=${HOSTNAME} --gaa remap_version=${nco_vrs}" # [sng] Global attributes to add
gll_fl='' # [sng] GLL grid metadata (geometry+connectivity+Jacobian) file
grd_dst='' # [sng] Destination grid-file
grd_dst_xmp='grd_dst.nc' # [sng] Destination grid-file for examples
grd_sng='' # [sng] Grid string
grd_src='' # [sng] Source grid-file
grd_src_xmp='grd_src.nc' # [sng] Source grid-file for examples
hdr_pad='10000' # [B] Pad at end of header section
hnt_dst='' # [sng] ERWG hint for destination grid
hnt_src='' # [sng] ERWG hint for source grid
in_fl='' # [sng] Input file
in_xmp='in.nc' # [sng] Input file for examples
inp_aut='No' # [sng] Input file list automatically generated (in ncclimo, or specified with -i in ncremap)
inp_glb='No' # [sng] Input file list from globbing directory
inp_psn='No' # [sng] Input file list from positional arguments
inp_std='No' # [sng] Input file list from stdin
job_nbr=2 # [nbr] Job simultaneity for parallelism
map_fl='' # [sng] Map-file
map_rsl_fl='' # [sng] File containing results of weight-generation command (i.e., map_fl or map_trn_fl for monotr)
map_trn_fl='' # [sng] Map-file transpose (for Tempest)
map_xmp='map.nc' # [sng] Map-file for examples
mlt_map_flg='Yes' # [sng] Multi-map flag
mpi_flg='No' # [sng] Parallelize over nodes
msh_fl='' # [sng] Mesh-file (for Tempest)
msk_dst='' # [sng] Mask-template variable in destination file
msk_out='' # [sng] Mask variable in regridded file
msk_src='' # [sng] Mask-template variable in source file
mss_val='-9.99999979021476795361e+33' # [frc] Missing value for MPAS (ocean+seaice)
#mss_val='-1.0e36' # [frc] Missing value for MPAS (landice)
nco_opt='-O --no_tmp_fl' # [sng] NCO defaults (e.g., '-O -6 -t 1')
nco_usr='' # [sng] NCO user-configurable options (e.g., '-D 1')
nd_nbr=1 # [nbr] Number of nodes
out_fl='' # [sng] Output file
out_xmp='out.nc' # [sng] Output file for examples
par_typ='nil' # [sng] Parallelism type
ppc_prc='' # [nbr] Precision-preserving compression number of significant digits
prc_typ='' # [sng] Procedure type
rgr_opt='--rgr lat_nm_out=lat#lon_nm_out=lon' # [sng] Regridding options
rnr_thr='' # [frc] Renormalization option
sgs_frc='landfrac' # [sng] Sub-grid fraction variable
sgs_msk='landmask' # [sng] Sub-grid mask variable
sgs_nrm='1.0' # [frc] Sub-grid normalization
std_flg='No' # [sng] Input available from pipe to stdin
thr_nbr=2 # [nbr] Thread number for regridder
tmp_out_fl='ncremap_grd_tmp.nc' # [sng] Temporary output file
trn_map='' # [flg] Tempest transpose map (i.e., fv2se_flx == monotr)
ugrid_fl='' # [sng] UGRID file
unq_sfx=".pid${spt_pid}" # [sng] Unique suffix
#var_lst='FSNT,AODVIS' # [sng] Variables to process (empty means all)
var_lst='' # [sng] Variables to process (empty means all)
var_rgr='' # [sng] CF template variable
var_xmp='FSNT' # [sng] Variable list for examples
vrb_lvl=2 # [sng] Verbosity level
vrb_0=0 # [enm] Verbosity level: Quiet
vrb_1=1 # [enm] Verbosity level: Standard, minimal file I/O
vrb_2=2 # [enm] Verbosity level: All file I/O
vrb_3=3 # [enm] Verbosity level: English
vrb_4=4 # [enm] Verbosity level: Pedantic
vrs_prn='No' # [sng] Print version information
wgt_exe_esmf='ESMF_RegridWeightGen' # [sng] ESMF executable
wgt_exe_tps='GenerateOfflineMap' # [sng] TempestRemap executable
wgt_typ='esmf' # [sng] Weight-generator program ('esmf' or 'tempest')
wgt_opt='' # [sng] Weight-generator options
#wgt_opt_esmf='--ignore_unmapped --netcdf4' # [sng] ESMF_RegridWeightGen options
wgt_opt_esmf='--ignore_unmapped' # [sng] ESMF_RegridWeightGen options
#wgt_opt_tps='--mono' # [sng] TempestRemap options
wgt_opt_tps='' # [sng] TempestRemap options
xtn_var='' # [sng] Extensive variables (e.g., 'TSurfStd_ct')
# Set temporary-file directory
if [ -d "${TMPDIR}" ]; then
# Fancy %/ syntax removes trailing slash (e.g., from $TMPDIR)
drc_tmp="${TMPDIR%/}"
elif [ -d '/tmp' ]; then
drc_tmp='/tmp'
else
drc_tmp=${PWD}
fi # !gpfs
function fnc_usg_prn { # NB: dash supports fnc_nm (){} syntax, not function fnc_nm{} syntax
# Print usage
printf "${fnt_rvr}Basic usage:\n${fnt_nrm} ${fnt_bld}$spt_nm -i in_fl -d dst_fl -o out_fl${fnt_nrm}\n"
printf "${fnt_nrm} ${fnt_bld}${spt_nm} --input_file=in_fl --destination=dst_fl --output_file=out_fl${fnt_nrm}\n\n"
echo "Command-line options [long-option synonyms in ${fnt_tlc}italics${fnt_nrm}]:"
echo "${fnt_rvr}-3${fnt_nrm} Output file format CLASSIC (netCDF3 classic CDF1) [${fnt_tlc}fl_fmt, file_format=classic${fnt_nrm}]"
echo "${fnt_rvr}-4${fnt_nrm} Output file format NETCDF4 (netCDF4 extended) [${fnt_tlc}fl_fmt, file_format=netcdf4${fnt_nrm}]"
echo "${fnt_rvr}-5${fnt_nrm} Output file format 64BIT_DATA (netCDF3/PnetCDF CDF5) [${fnt_tlc}fl_fmt, file_format=64bit_data${fnt_nrm}]"
echo "${fnt_rvr}-6${fnt_nrm} Output file format 64BIT_OFFSET (netCDF3 64bit CDF2) [${fnt_tlc}fl_fmt, file_format=64bit_offset${fnt_nrm}]"
echo "${fnt_rvr}-7${fnt_nrm} Output file format NETCDF4_CLASSIC (netCDF4 classic) [${fnt_tlc}fl_fmt, file_format=netcdf4_classic${fnt_nrm}]"
echo "${fnt_rvr}-a${fnt_nrm} ${fnt_bld}alg_typ${fnt_nrm} Algorithm for weight generation (default ${fnt_bld}${alg_typ}${fnt_nrm}) [${fnt_tlc}alg_typ, algorithm, regrid_algorithm${fnt_nrm}]"
echo " ESMF algorithms: bilinear|conserve|nearestdtos|neareststod|patch|tempest|se2fv_flx|se2fv_stt|se2fv_alt|fv2se_flx|fv2se_stt|fv2se_alt"
echo " Tempest algorithms: tempest|se2fv_flx|se2fv_stt|se2fv_alt|fv2se_flx|fv2se_stt|fv2se_alt"
echo "${fnt_rvr}-d${fnt_nrm} ${fnt_bld}dst_fl${fnt_nrm} Data file to infer destination grid from (empty means none, i.e., use grd_fl, grd_sng or map_fl)) (default ${fnt_bld}${dst_fl}${fnt_nrm}) [${fnt_tlc}dst_fl, destination_file, template_file, template${fnt_nrm}]"
echo "${fnt_rvr}-D${fnt_nrm} ${fnt_bld}dbg_lvl${fnt_nrm} Debug level (default ${fnt_bld}${dbg_lvl}${fnt_nrm}) [${fnt_tlc}dbg_lvl, dbg, debug, debug_level${fnt_nrm}]"
echo " ${fnt_bld}--fl_fmt${fnt_nrm} File format (empty is netCDF3 64bit CDF2) (default ${fnt_bld}${fl_fmt}${fnt_nrm}) [${fnt_tlc}fl_fmt, fmt_out, file_format, format_out${fnt_nrm}]"
echo "${fnt_rvr}-G${fnt_nrm} ${fnt_bld}grd_sng${fnt_nrm} Grid generation argument string (empty means none) (default ${fnt_bld}${grd_sng}${fnt_nrm}) [${fnt_tlc}grd_sng, grid_generation, grid_gen, grid_string${fnt_nrm}]"
echo "${fnt_rvr}-g${fnt_nrm} ${fnt_bld}grd_dst${fnt_nrm} Grid-file (destination) (empty means none, i.e., infer from dst_fl or use grd_sng or map_fl) (default ${fnt_bld}${grd_dst}${fnt_nrm}) [${fnt_tlc}grd_dst, grid_dest, dst_grd, dest_grid, destination_grid${fnt_nrm}]"
echo " ${fnt_bld}--gll_fl${fnt_nrm} GLL metadata (SE grid geometry+connectivity+Jacobian) file (default ${fnt_bld}${gll_fl}${fnt_nrm}) [${fnt_tlc}gll_fl, gll_mtd, se_gmt, se_mtd${fnt_nrm}]"
echo "${fnt_rvr}-I${fnt_nrm} ${fnt_bld}drc_in${fnt_nrm} Input directory (empty means none) (default ${fnt_bld}${drc_in}${fnt_nrm}) [${fnt_tlc}drc_in, in_drc, dir_in, in_dir, input${fnt_nrm}]"
echo "${fnt_rvr}-i${fnt_nrm} ${fnt_bld}in_fl${fnt_nrm} Input file (empty means pipe to stdin or drc_in) (default ${fnt_bld}${in_fl}${fnt_nrm}) [${fnt_tlc}in_fl, in_file, input_file${fnt_nrm}]"
echo "${fnt_rvr}-j${fnt_nrm} ${fnt_bld}job_nbr${fnt_nrm} Job simultaneity for parallelism (default ${fnt_bld}${job_nbr}${fnt_nrm}) [${fnt_tlc}job_nbr, job_number, jobs${fnt_nrm}]"
echo "${fnt_rvr}-L${fnt_nrm} ${fnt_bld}dfl_lvl${fnt_nrm} Deflate level (empty is none) (default ${fnt_bld}${dfl_lvl}${fnt_nrm}) [${fnt_tlc}dfl_lvl, dfl, deflate${fnt_nrm}]"
echo "${fnt_rvr}-M${fnt_nrm} Multi-map-file toggle (unset means generate one map-file per input file) [${fnt_tlc}mlt_map, no_multimap${fnt_nrm}]"
echo "${fnt_rvr}-m${fnt_nrm} ${fnt_bld}map_fl${fnt_nrm} Map-file (empty means generate internally) (default ${fnt_bld}${map_fl}${fnt_nrm}) [${fnt_tlc}map_fl, map, map_file, rgr_map, regrid_map${fnt_nrm}]"
echo " ${fnt_bld}--msk_dst${fnt_nrm} Mask-template variable in destination file (empty means none) (default ${fnt_bld}${msk_dst}${fnt_nrm}) [${fnt_tlc}msk_dst, dst_msk, mask_destination, mask_dst${fnt_nrm}]"
echo " ${fnt_bld}--msk_out${fnt_nrm} Mask variable in regridded file (empty means none) (default ${fnt_bld}${msk_out}${fnt_nrm}) [${fnt_tlc}msk_out, out_msk, mask_output, mask_rgr${fnt_nrm}]"
echo " ${fnt_bld}--msk_src${fnt_nrm} Mask-template variable in source file (empty means none) (default ${fnt_bld}${msk_src}${fnt_nrm}) [${fnt_tlc}msk_src, src_msk, mask_source, mask_src${fnt_nrm}]"
echo " ${fnt_bld}--mss_val${fnt_nrm} Missing value for MPAS (empty means none) (default ${fnt_bld}${mss_val}${fnt_nrm}) [${fnt_tlc}mss_val, fll_val, missing_value, fill_value${fnt_nrm}]"
echo "${fnt_rvr}-n${fnt_nrm} ${fnt_bld}nco_opt${fnt_nrm} NCO options (empty means none) (default ${fnt_bld}${nco_opt}${fnt_nrm}) [${fnt_tlc}nco_opt, nco_options${fnt_nrm}]"
echo " ${fnt_bld}--no_cll_msr${fnt_nrm} Omit cell_measures variables (e.g., 'area') [${fnt_tlc}no_area, no_cll_msr, no_cell_measures${fnt_nrm}]"
echo " ${fnt_bld}--no_frm_trm${fnt_nrm} Omit formula_terms variables (e.g., 'hyba', 'PS') [${fnt_tlc}no_frm_trm, no_formula_terms${fnt_nrm}]"
echo " ${fnt_bld}--no_stg_grd${fnt_nrm} Omit staggered grid variables ('slat, slon, w_stag') [${fnt_tlc}no_stg_grd, no_stg, no_stagger, no_staggered_grid${fnt_nrm}]"
echo "${fnt_rvr}-O${fnt_nrm} ${fnt_bld}drc_out${fnt_nrm} Output directory (default ${fnt_bld}${drc_out}${fnt_nrm}) [${fnt_tlc}drc_out, out_drc, dir_out, out_dir, output${fnt_nrm}]"
echo "${fnt_rvr}-o${fnt_nrm} ${fnt_bld}out_fl${fnt_nrm} Output-file (regridded file) (empty copies Input filename) (default ${fnt_bld}${out_fl}${fnt_nrm}) [${fnt_tlc}out_fl, out_file, output_file${fnt_nrm}]"
echo "${fnt_rvr}-P${fnt_nrm} ${fnt_bld}prc_typ${fnt_nrm} Procedure type (empty means none) (default ${fnt_bld}${prc_typ}${fnt_nrm}) [${fnt_tlc}prc_typ, pdq_typ, prm_typ, procedure${fnt_nrm}]"
echo "${fnt_rvr}-p${fnt_nrm} ${fnt_bld}par_typ${fnt_nrm} Parallelism type (default ${fnt_bld}${par_typ}${fnt_nrm}) [${fnt_tlc}par_typ, par_md, parallel_type, parallel_mode, parallel${fnt_nrm}]"
# 20171101: Implement but do not yet advertise PPC in ncremap
# echo " ${fnt_bld}--ppc${fnt_nrm} ${fnt_bld}ppc_prc${fnt_nrm} Precision-preserving compression (empty means none) (default ${fnt_bld}${ppc_prc}${fnt_nrm}) [${fnt_tlc}ppc, precision, quantize${fnt_nrm}]"
echo "${fnt_rvr}-R${fnt_nrm} ${fnt_bld}rgr_opt${fnt_nrm} Regrid options (empty means none) (default ${fnt_bld}${rgr_opt}${fnt_nrm}) [${fnt_tlc}rgr_opt, regrid_options${fnt_nrm}]"
echo "${fnt_rvr}-r${fnt_nrm} ${fnt_bld}rnr_thr${fnt_nrm} Renormalization threshold (empty means none) (default ${fnt_bld}${rnr_thr}${fnt_nrm}) [${fnt_tlc}rnr_thr, thr_rnr, renormalize_threshold${fnt_nrm}]"
echo " ${fnt_bld}--rgn_dst${fnt_nrm} Regional destination grid [${fnt_tlc}rgn_dst, dst_rgn, regional_destination${fnt_nrm}]"
echo " ${fnt_bld}--rgn_src${fnt_nrm} Regional source grid [${fnt_tlc}rgn_src, src_rgn, regional_source${fnt_nrm}]"
echo "${fnt_rvr}-s${fnt_nrm} ${fnt_bld}grd_src${fnt_nrm} Grid-file (source) (empty means infer or use map_fl) (default ${fnt_bld}${grd_src}${fnt_nrm}) [${fnt_tlc}grd_src, grid_source, source_grid, src_grd${fnt_nrm}]"
echo " ${fnt_bld}--sgs_frc${fnt_nrm} Sub-grid fraction variable (empty means none) (default ${fnt_bld}${sgs_frc}${fnt_nrm}) [${fnt_tlc}sgs_frc, ice_frc, lnd_frc, ocn_frc, subgrid_fraction${fnt_nrm}]"
echo " ${fnt_bld}--sgs_msk${fnt_nrm} Sub-grid mask variable (empty means none) (default ${fnt_bld}${sgs_msk}${fnt_nrm}) [${fnt_tlc}sgs_msk, ice_msk, lnd_msk, ocn_msk, subgrid_mask${fnt_nrm}]"
echo " ${fnt_bld}--sgs_nrm${fnt_nrm} Sub-grid fraction normalization (empty means none) (default ${fnt_bld}${sgs_nrm}${fnt_nrm}) [${fnt_tlc}sgs_nrm, subgrid_normalization${fnt_nrm}]"
echo " ${fnt_bld}--std_flg${fnt_nrm} Stdin used for input (default ${fnt_bld}${inp_std}${fnt_nrm}) [${fnt_tlc}stdin, std_flg, inp_std, redirect, standard_input${fnt_nrm}]"
echo "${fnt_rvr}-T${fnt_nrm} ${fnt_bld}drc_tmp${fnt_nrm} Temporary directory (for intermediate files) (default ${fnt_bld}${drc_tmp}${fnt_nrm}) [${fnt_tlc}drc_tmp, tmp_drc, dir_tmp, tmp_dir, tmp${fnt_nrm}]"
echo "${fnt_rvr}-t${fnt_nrm} ${fnt_bld}thr_nbr${fnt_nrm} Thread number for regridder (default ${fnt_bld}${thr_nbr}${fnt_nrm}) [${fnt_tlc}thr_nbr, thread_number, thread, threads${fnt_nrm}]"
echo "${fnt_rvr}-U${fnt_nrm} Unpack input prior to regridding [${fnt_tlc}unpack, upk, upk_inp${fnt_nrm}]"
echo "${fnt_rvr}-u${fnt_nrm} ${fnt_bld}unq_sfx${fnt_nrm} Unique suffix (prevents intermediate files from sharing names) (default ${fnt_bld}${unq_sfx}${fnt_nrm}) [${fnt_tlc}unq_sfx, unique_suffix, suffix${fnt_nrm}]"
echo " ${fnt_bld}--ugrid_fl${fnt_nrm} UGRID file (empty means none) (default ${fnt_bld}${ugrid_fl}${fnt_nrm}) [${fnt_tlc}ugrid_fl, ugrid, ugrid_file${fnt_nrm}]"
echo "${fnt_rvr}-V${fnt_nrm} ${fnt_bld}var_rgr${fnt_nrm} CF template variable (empty means none) (default ${fnt_bld}${var_rgr}${fnt_nrm}) [${fnt_tlc}var_rgr, rgr_var, var_cf, cf_var, cf_variable${fnt_nrm}]"
echo "${fnt_rvr}-v${fnt_nrm} ${fnt_bld}var_lst${fnt_nrm} Variable list (empty means all) (default ${fnt_bld}${var_lst}${fnt_nrm}) [${fnt_tlc}var_lst, variable_list, var, vars, variable, variables${fnt_nrm}]"
echo " ${fnt_bld}--version${fnt_nrm} Version and configuration information [${fnt_tlc}version, vrs, config, configuration, cnf${fnt_nrm}]"
echo " ${fnt_bld}--vrb_lvl${fnt_nrm} Verbosity level (default ${fnt_bld}${vrb_lvl}${fnt_nrm}) [${fnt_tlc}vrb_lvl, vrb, verbosity, print_verbosity${fnt_nrm}]"
echo "${fnt_rvr}-W${fnt_nrm} ${fnt_bld}wgt_opt${fnt_nrm} Weight-generator options (default ${fnt_bld}${wgt_opt_esmf}${fnt_nrm}) [${fnt_tlc}wgt_opt, esmf_opt, esmf_options, tempest_opt, tps_opt${fnt_nrm}]"
echo "${fnt_rvr}-w${fnt_nrm} ${fnt_bld}wgt_cmd${fnt_nrm} Weight-generator command (default ${fnt_bld}${wgt_exe_esmf}${fnt_nrm}) [${fnt_tlc}wgt_cmd, wgt_gnr, weight_command, weight_generator${fnt_nrm}]"
echo "${fnt_rvr}-x${fnt_nrm} ${fnt_bld}xtn_var${fnt_nrm} Extensive variables (empty means none) (default ${fnt_bld}${xtn_var}${fnt_nrm}) [${fnt_tlc}xtn_var, xtn_lst, extensive, var_xtn, extensive_variables${fnt_nrm}]"
printf "\n"
printf "Examples: ${fnt_bld}$spt_nm -i ${in_xmp} -m ${map_xmp} -o ${out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -i ${in_xmp} -d ${dst_xmp} -o ${out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -i ${in_xmp} -g ${grd_dst_xmp} -o ${out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -s ${grd_src_xmp} -g ${grd_dst_xmp} -m ${map_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -a bilinear -i ${in_xmp} -d ${dst_xmp} -o ${out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -a conserve -i ${in_xmp} -d ${dst_xmp} -o ${out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -a tempest -i ${in_xmp} -d ${dst_xmp} -o ${out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -v ${var_xmp} -i ${in_xmp} -m ${map_xmp} -o ${out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -I ${drc_in_xmp} -m ${map_xmp} -O ${drc_out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -M -I ${drc_in_xmp} -d ${dst_xmp} -O ${drc_out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -M -I ${drc_in_xmp} -g ${grd_dst_xmp} -O ${drc_out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -I ${drc_in_xmp} -s ${grd_src_xmp} -d ${dst_xmp} -O ${drc_out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -I ${drc_in_xmp} -s ${grd_src_xmp} -g ${grd_dst_xmp} -O ${drc_out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -I ${drc_in_xmp} -d ${dst_xmp} -O ${drc_out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}$spt_nm -I ${drc_in_xmp} -g ${grd_dst_xmp} -O ${drc_out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}ls mdl*2005*nc | $spt_nm -m ${map_xmp} -O ${drc_out_xmp} ${fnt_nrm}\n"
printf " ${fnt_bld}ls mdl*2005*nc | $spt_nm -d ${dst_xmp} -O ${drc_out_xmp} ${fnt_nrm}\n"
printf "\nComplete documentation at http://nco.sf.net/nco.html#${spt_nm}\n\n"
exit 1
} # end fnc_usg_prn()
function dst_is_grd {
# Purpose: Is destination grid specified as SCRIP grid-file?
# fxm: Not working yet
# Figure-out whether data-file or grid-file and proceed accordingly
# Will allow ncremap to combine -d and -g switches
# Usage: dst_is_grd ${fl}
fl=${1}
flg='Yes'
#flg='No'
} # end dst_is_grd()
# Check argument number and complain accordingly
arg_nbr=$#
if [ ${arg_nbr} -eq 0 ]; then
fnc_usg_prn
fi # !arg_nbr
# Parse command-line options:
# http://stackoverflow.com/questions/402377/using-getopts-in-bash-shell-script-to-get-long-and-short-command-line-options
# http://tuxtweaks.com/2014/05/bash-getopts
while getopts :34567a:CD:d:f:g:G:h:I:i:j:L:Mm:n:O:o:P:p:R:r:s:T:t:Uu:V:v:W:w:x:-: OPT; do
case ${OPT} in
3) fl_fmt='3' ;; # File format
4) fl_fmt='4' ;; # File format
5) fl_fmt='5' ;; # File format
6) fl_fmt='6' ;; # File format
7) fl_fmt='7' ;; # File format
a) alg_typ="${OPTARG}" ;; # Algorithm
C) clm_flg='Yes' ;; # Climo flag (undocumented)
D) dbg_lvl="${OPTARG}" ;; # Debugging level
d) dst_fl="${OPTARG}" ;; # Destination file
g) grd_dst="${OPTARG}" ;; # Destination grid-file
G) grd_sng="${OPTARG}" ;; # Grid generation string
I) drc_in="${OPTARG}" ;; # Input directory
i) in_fl="${OPTARG}" ;; # Input file
j) job_usr="${OPTARG}" ;; # Job simultaneity
L) dfl_lvl="${OPTARG}" ;; # Deflate level
M) mlt_map_flg='No' ;; # Multi-map flag
m) map_fl="${OPTARG}" ;; # Map-file
n) nco_usr="${OPTARG}" ;; # NCO options
O) drc_usr="${OPTARG}" ;; # Output directory
o) out_fl="${OPTARG}" ;; # Output file
P) prc_typ="${OPTARG}" ;; # Procedure type
p) par_typ="${OPTARG}" ;; # Parallelism type
r) rnr_thr="${OPTARG}" ;; # Renormalization threshold
R) rgr_opt="${OPTARG}" ;; # Regridding options
s) grd_src="${OPTARG}" ;; # Source grid-file
T) tmp_usr="${OPTARG}" ;; # Temporary directory
t) thr_usr="${OPTARG}" ;; # Thread number
U) pdq_opt='-U' ;; # Unpack input
u) unq_usr="${OPTARG}" ;; # Unique suffix
V) var_rgr="${OPTARG}" ;; # CF template variable
v) var_lst="${OPTARG}" ;; # Variables
W) wgt_opt_usr="${OPTARG}" ;; # Weight-generator options
w) wgt_usr="${OPTARG}" ;; # Weight-generator command
x) xtn_var="${OPTARG}" ;; # Extensive variables
-) LONG_OPTARG="${OPTARG#*=}"
case ${OPTARG} in
# Hereafter ${OPTARG} is long argument key, and ${LONG_OPTARG}, if any, is long argument value
# Long options with no argument, no short option counterpart
# Long options with argument, no short option counterpart
# Long options with short counterparts, ordered by short option key
alg_typ=?* | algorithm=?* | regrid_algorithm=?* ) alg_typ="${LONG_OPTARG}" ;; # -a # Algorithm
clm_flg=?* | climatology_flag=?* ) clm_flg='Yes' ;; # -C # Climo flag (undocumented)
dbg_lvl=?* | dbg=?* | debug=?* | debug_level=?* ) dbg_lvl="${LONG_OPTARG}" ;; # -d # Debugging level
dfl_lvl=?* | deflate=?* | dfl=?* ) dfl_lvl="${LONG_OPTARG}" ;; # -L # Deflate level
dst_fl=?* | destination_file=?* | template_file=?* | template=?* ) dst_fl="${LONG_OPTARG}" ;; # -d # Destination file
grd_dst=?* | grid_dest=?* | dst_grd=?* | dest_grid=?* | destination_grid=?* ) grd_dst="${LONG_OPTARG}" ;; # -g # Destination grid-file
grd_sng=?* | grid_generation=?* | grid_gen=?* | grid_string=?* ) grd_sng="${LONG_OPTARG}" ;; # -G # Grid generation string
drc_in=?* | in_drc=?* | dir_in=?* | in_dir=?* | input=?* ) drc_in="${LONG_OPTARG}" ;; # -i # Input directory
fl_fmt=?* | fmt_out=?* | file_format=?* | format_out=?* ) fl_fmt="${LONG_OPTARG}" ;; # # Output file format
gll_fl=?* | gll_mtd=?* | se_gmt=?* | se_mtd=?* ) gll_fl="${LONG_OPTARG}" ;; # # GLL grid metadata (geometry+connectivity+Jacobian) file
in_fl=?* | in_file=?* | input_file=?* ) in_fl="${LONG_OPTARG}" ;; # -i # Input file
job_nbr=?* | job_number=?* | jobs=?* ) job_usr="${LONG_OPTARG}" ;; # -j # Job simultaneity
mlt_map | multimap | no_multimap | nomultimap ) mlt_map_flg='No' ;; # -M # Multi-map flag
mlt_map=?* | multimap=?* | no_multimap=?* | nomultimap=?* ) echo "No argument allowed for --${OPTARG switch}" >&2; exit 1 ;; # -M # Multi-map flag
map_fl=?* | map=?* | map_file=?* | rgr_map=?* | regrid_map=?* ) map_fl="${LONG_OPTARG}" ;; # -m # Map-file
msk_dst=?* | dst_msk=?* | mask_destination=?* | mask_dst=?* ) msk_dst="${LONG_OPTARG}" ;; # # Mask-template variable in destination file
msk_out=?* | out_msk=?* | mask_output=?* | mask_out=?* ) msk_out="${LONG_OPTARG}" ;; # # Mask variable in regridded file
msk_src=?* | src_msk=?* | mask_source=?* | mask_src=?* ) msk_src="${LONG_OPTARG}" ;; # # Mask-template variable in source file
mss_val=?* | fll_val=?* | missing_value=?* | fill_value=?* ) mss_val="${LONG_OPTARG}" ;; # # Missing value for MPAS
nco_opt=?* | nco=?* | nco_options=?* ) nco_usr="${LONG_OPTARG}" ;; # -n # NCO options
no_area | no_cll_msr | no_cell_measures ) no_cll_msr='Yes' ;; # # Omit cell_measures variables
no_area=?* | no_cell_msr=?* | no_cell_measures=?* ) echo "No argument allowed for --${OPTARG switch}" >&2; exit 1 ;; # # Omit cell_measures variables
no_frm_trm | no_frm | no_formula_terms ) no_frm_trm='Yes' ;; # # Omit formula_terms variables
no_frm_trm=?* | no_frm=?* | no_formula_terms=?* ) echo "No argument allowed for --${OPTARG switch}" >&2; exit 1 ;; # # Omit formula_terms variables
no_stg_grd | no_stg | no_stagger | no_staggered_grid ) no_stg_grd='Yes' ;; # # Omit staggered grid variables
no_stg_grd=?* | no_stg=?* | no_stagger=?* | no_staggered_grid ) echo "No argument allowed for --${OPTARG switch}" >&2; exit 1 ;; # # Omit staggered grid variables
drc_out=?* | out_drc=?* | dir_out=?* | out_dir=?* | output=?* ) drc_usr="${LONG_OPTARG}" ;; # -O # Output directory
out_fl=?* | output_file=?* | out_file=?* ) out_fl="${LONG_OPTARG}" ;; # -o # Output file
prc_typ=?* | pdq_typ=?* | prm_typ=?* | procedure=?* ) prc_typ="${LONG_OPTARG}" ;; # -P # Procedure type
par_typ=?* | par_md=?* | parallel_type=?* | parallel_mode=?* | parallel=?* ) par_typ="${LONG_OPTARG}" ;; # -p # Parallelism type
ppc=?* | ppc_prc=?* | precision=?* | quantize=?* ) ppc_prc="${LONG_OPTARG}" ;; # # Precision-preserving compression
rgr_opt=?* | regrid_options=?* ) rgr_opt="${LONG_OPTARG}" ;; # -R # Regridding options
rnr_thr=?* | thr_rnr=?* | renormalization_threshold=?* ) rnr_thr="${LONG_OPTARG}" ;; # -r # Renormalization threshold
rgn_dst=?* | dst_rgn=?* | regional_destination=?* ) hnt_dst='--dst_regional' ;; # # Regional destination grid
rgn_dst=?* | dst_rgn=?* | regional_destination=?* ) echo "No argument allowed for --${OPTARG switch}" >&2; exit 1 ;; # # Regional destination grid
rgn_src=?* | src_rgn=?* | regional_source=?* ) hnt_src='--src_regional' ;; # # Regional source grid
rgn_src=?* | src_rgn=?* | regional_source=?* ) echo "No argument allowed for --${OPTARG switch}" >&2; exit 1 ;; # # Regional source grid
grd_src=?* | grid_source=?* | source_grid=?* | src_grd=?* ) grd_src="${LONG_OPTARG}" ;; # -s # Source grid-file
sgs_frc=?* | ice_frc=?* | lnd_frc=?* | ocn_frc=?* | subgrid_fraction=?* ) sgs_frc="${LONG_OPTARG}" ; prc_typ='sgs' ; ;; # # Sub-grid fraction variable
sgs_msk=?* | ice_msk=?* | lnd_msk=?* | ocn_msk=?* | subgrid_mask=?* ) sgs_msk="${LONG_OPTARG}" ; prc_typ='sgs' ; ;; # # Sub-grid mask variable
sgs_nrm=?* | subgrid_normalization=?* ) sgs_nrm="${LONG_OPTARG}" ; prc_typ='sgs' ; ;; # # Sub-grid fraction normalization
stdin | inp_std | std_flg | redirect | standard_input ) inp_std='Yes' ;; # # Input file list from stdin
stdin=?* | inp_std=?* | std_flg=?* | redirect=?* | standard_input=?* ) echo "No argument allowed for --${OPTARG switch}" >&2; exit 1 ;; # # Input file list from stdin
drc_tmp=?* | tmp_drc=?* | dir_tmp=?* | tmp_dir=?* | tmp=?* ) tmp_usr="${LONG_OPTARG}" ;; # -T # Temporary directory
thr_nbr=?* | thread_number=?* | thread=?* | threads=?* ) thr_usr="${LONG_OPTARG}" ;; # -t # Thread number
unpack=?* | upk=?* | upk_inp=?* ) pdq_opt='-U' ;; # -U # Unpack input
unpack=?* | upk=?* | upk_inp=?* ) echo "No argument allowed for --${OPTARG switch}" >&2; exit 1 ;; # -U # Unpack input
ugrid_fl=?* | ugrid=?* | ugrid_file=?* ) ugrid_fl="${LONG_OPTARG}" ;; # # UGRID file
unq_sfx=?* | unique_suffix=?* | suffix=?* ) unq_usr="${LONG_OPTARG}" ;; # -u # Unique suffix
var_rgr=?* | rgr_var=?* | var_cf=?* | cf_var=?* | cf_variable=?* ) var_rgr="${LONG_OPTARG}" ;; # -V # CF template variable
var_lst=?* | variable_list=?* | var=?* | vars=?* | variable=?* | variables=?* ) var_lst="${LONG_OPTARG}" ;; # -v # Variables
vrb_lvl=?* | vrb=?* | verbosity=?* | print_verbosity=?* ) vrb_lvl="${LONG_OPTARG}" ;; # # Print verbosity
version | vrs | config | configuration | cnf ) vrs_prn='Yes' ;; # # Print version information
wgt_opt=?* | esmf_opt=?* | esmf_options=?* | tps_opt=?* | tempest_opt=?* | tempest_options=?* ) wgt_opt_usr="${LONG_OPTARG}" ;; # -W # Weight-generator options
wgt_cmd=?* | weight_command=?* | wgt_gnr=?* | weight_generator=?* ) wgt_usr="${LONG_OPTARG}" ;; # -w # Weight-generator command
xtn_var=?* | extensive=?* | var_xtn=?* | extensive_variables=?* ) xtn_var="${LONG_OPTARG}" ;; # -x # Extensive variables
'' ) break ;; # "--" terminates argument processing
* ) printf "\nERROR: Unrecognized option ${fnt_bld}--${OPTARG}${fnt_nrm}\n" >&2; fnc_usg_prn ;;
esac ;; # !OPTARG
\?) # Unrecognized option
printf "\nERROR: Option ${fnt_bld}-${OPTARG}${fnt_nrm} not recognized\n" >&2
fnc_usg_prn ;;
esac # !OPT
done # !getopts
shift $((OPTIND-1)) # Advance one argument
psn_nbr=$#
if [ ${psn_nbr} -ge 1 ]; then
inp_psn='Yes'
fi # !psn_nbr
if [ ${vrs_prn} = 'Yes' ]; then
printf "${spt_nm}, the NCO regridder and map- and grid-generator, version ${nco_vrs}\n"
printf "Copyright (C) 2016--2018 Charlie Zender\n"
printf "This program is part of NCO, the netCDF Operators\n"
printf "NCO is free software and comes with a BIG FAT KISS and ABSOLUTELY NO WARRANTY\n"
printf "You may redistribute and/or modify NCO under the terms of the\n"
printf "GNU General Public License (GPL) Version 3 with exceptions described in the LICENSE file\n"
printf "GPL: http://www.gnu.org/copyleft/gpl.html\n"
printf "LICENSE: https://github.com/nco/nco/tree/master/LICENSE\n"
printf "Config: ${spt_nm} running from directory ${drc_spt}\n"
printf "Config: Calling NCO binaries in directory ${drc_nco}\n"
printf "Config: Binaries linked to netCDF library version ${lbr_vrs}\n"
if [ "${hrd_pth_fnd}" = 'Yes' ]; then
printf "Config: Employ NCO machine-dependent hardcoded paths/modules for ${HOSTNAME}\n"
printf "Config: (Turn-off NCO hardcoded paths with \"export NCO_PATH_OVERRIDE=No\")\n"
else
printf "Config: No hardcoded path/module overrides\n"
fi # !hrd_pth_fnd
tst_cmd=${wgt_exe_esmf}
cmd_wgt=`command -v ${tst_cmd} 2> /dev/null`
if [ $? -eq 0 ]; then
printf "Config: ESMF weight-generation command ${tst_cmd} found as ${cmd_wgt}\n"
else
printf "Config: ESMF weight-generation command ${tst_cmd} not found\n"
fi # !err
tst_cmd=${wgt_exe_tps}
cmd_wgt=`command -v ${tst_cmd} 2> /dev/null`
if [ $? -eq 0 ]; then
printf "Config: Tempest weight-generation command ${tst_cmd} found as ${cmd_wgt}\n"
else
printf "Config: Tempest weight-generation command ${tst_cmd} not found\n"
fi # !err
exit 0
fi # !vrs_prn
# Detect input on pipe to stdin:
# http://stackoverflow.com/questions/2456750/detect-presence-of-stdin-contents-in-shell-script
# http://unix.stackexchange.com/questions/33049/check-if-pipe-is-empty-and-run-a-command-on-the-data-if-it-isnt
# 20170119 "if [ ! -t 0 ]" tests whether unit 0 (stdin) is connected to terminal, not whether pipe has data
# Non-interactive batch mode (e.g., qsub, sbatch) disconnects stdin from terminal and triggers false-positives with ! -t 0
# 20170123 "if [ -p foo ]" tests whether foo exists and is a pipe or named pipe
# Non-interactive batch mode (i.e., sbatch) behaves as desired for -p /dev/stdin on SLURM
# Non-interactive batch mode (e.g., qsub) always returns true for -p /dev/stdin on PBS, leads to FALSE POSITIVES!
# This is because PBS uses stdin to set the job name
# Hence -p /dev/stdin test works everywhere tested except PBS non-interactive batch environment
if [ -n "${PBS_ENVIRONMENT}" ]; then
if [ "${PBS_ENVIRONMENT}" = 'PBS_BATCH' ]; then
# PBS batch detection suggested by OLCF ticket CCS #338970 on 20170127
bch_pbs='Yes'
fi # !PBS_ENVIRONMENT
fi # !PBS
if [ -n "${SLURM_JOBID}" ] && [ -z "${SLURM_PTY_PORT}" ]; then
# SLURM batch detection suggested by NERSC ticket INC0096873 on 20170127
bch_slr='Yes'
fi # !SLURM
if [ ${bch_pbs} = 'Yes' ] || [ ${bch_slr} = 'Yes' ]; then
# Batch environment
if [ ${bch_pbs} = 'Yes' ]; then
if [ ! -p /dev/stdin ]; then
# PBS batch jobs cause -p to return true except for stdin redirection
# When -p returns true we do not know whether stdin pipe contains any input
# User must explicitly indicate use of stdin pipes with --stdin option
# Redirection in PBS batch jobs unambiguously causes -p to return false
inp_std='Yes'
fi # !stdin
fi # !bch_slr
if [ ${bch_slr} = 'Yes' ]; then
if [ -p /dev/stdin ]; then
# SLURM batch jobs cause -p to return true for stdin pipes
# When -p returns false we do not know whether output was redirectd
# User must explicitly indicate use of redirection with --stdin option
# Stdin pipes in SLURM batch jobs unambiguously cause -p to return true
inp_std='Yes'
fi # !stdin
fi # !bch_slr
else # !bch
# Interactive environment
if [ -p /dev/stdin ] || [ ! -t 0 ]; then
# Interactive environments unambiguously cause -p to return true for stdin pipes
# Interactive environments unambiguously cause -t 0 to return false for stdin redirection
inp_std='Yes'
fi # !stdin
fi # !bch
if [ ${inp_std} = 'Yes' ] && [ ${inp_psn} = 'Yes' ]; then
echo "${spt_nm}: ERROR expecting input both from stdin and positional command-line arguments\n"
exit 1
fi # !inp_std
# Derived variables
if [ -n "${drc_usr}" ]; then
drc_out="${drc_usr%/}"
else
if [ -n "${out_fl}" ]; then
drc_out="$(dirname ${out_fl})"
fi # !out_fl
fi # !drc_usr
if [ -n "${tmp_usr}" ]; then
# Fancy %/ syntax removes trailing slash (e.g., from $TMPDIR)
drc_tmp=${tmp_usr%/}
fi # !out_fl
att_fl="${drc_tmp}/ncremap_tmp_att.nc" # [sng] Missing value workflow (MPAS) default
grd_dst_dfl="${drc_tmp}/ncremap_tmp_grd_dst.nc" # [sng] Grid-file (destination) default
grd_src_dfl="${drc_tmp}/ncremap_tmp_grd_src.nc" # [sng] Grid-file (source) default
hnt_dst_fl="${drc_tmp}/ncremap_tmp_hnt_dst.txt" # [sng] Hint (for ERWG) destination
hnt_src_fl="${drc_tmp}/ncremap_tmp_hnt_src.txt" # [sng] Hint (for ERWG) source
ncwa_fl="${drc_tmp}/ncremap_tmp_ncwa.nc" # [sng] ncwa workflow (HIRDLS, MLS) default
pdq_fl="${drc_tmp}/ncremap_tmp_pdq.nc" # [sng] Permuted/Unpacked data default (AIRS, HIRDLS, MLS, MOD04, MPAS)
tmp_out_fl="${drc_tmp}/${tmp_out_fl}" # [sng] Temporary output file
znl_fl="${drc_tmp}/ncremap_tmp_znl.nc" # [sng] Zonal workflow (HIRDLS, MLS) default
if [ -n "${unq_usr}" ]; then
if [ "${unq_usr}" = 'noclean' ]; then
cln_flg='No'
else
if [ "${unq_usr}" != 'none' ] && [ "${unq_usr}" != 'nil' ]; then
unq_sfx="${unq_usr}"
else # !unq_usr
unq_sfx=""
fi # !unq_usr
fi # !unq_usr
fi # !unq_sfx
att_fl=${att_fl}${unq_sfx}
grd_dst_dfl=${grd_dst_dfl}${unq_sfx}
grd_src_dfl=${grd_src_dfl}${unq_sfx}
hnt_dst_fl=${hnt_dst_fl}${unq_sfx}
hnt_src_fl=${hnt_src_fl}${unq_sfx}
ncwa_fl=${ncwa_fl}${unq_sfx}
pdq_fl=${pdq_fl}${unq_sfx}
tmp_out_fl=${tmp_out_fl}${unq_sfx}
znl_fl=${znl_fl}${unq_sfx}
# Algorithm options are bilinear|conserve|nearestdtos|neareststod|patch|tempest|se2fv_flx|se2fv_stt|se2fv_alt|fv2se_flx|fv2se_stt|fv2se_alt
if [ ${alg_typ} = 'bilinear' ] || [ ${alg_typ} = 'bln' ]; then
alg_opt='bilinear'
elif [ ${alg_typ} = 'conserve' ] || [ ${alg_typ} = 'conservative' ] || [ ${alg_typ} = 'cns' ]; then
alg_opt='conserve'
elif [ ${alg_typ} = 'nearestdtos' ] || [ ${alg_typ} = 'nds' ] || [ ${alg_typ} = 'dtos' ]; then
alg_opt='nearestdtos'
elif [ ${alg_typ} = 'neareststod' ] || [ ${alg_typ} = 'nsd' ] || [ ${alg_typ} = 'stod' ]; then
alg_opt='neareststod'
elif [ ${alg_typ} = 'patch' ] || [ ${alg_typ} = 'pch' ] || [ ${alg_typ} = 'ptc' ]; then
alg_opt='patch'
elif [ ${alg_typ} = 'tempest' ] || [ ${alg_typ} = 'tps' ] || [ ${alg_typ} = 'tmp' ]; then
# 20171108 'tempest' invokes TempestRemap with no automatic options, suitable for RLL re-mapping?
# 20171108 TempestRemap boutique options based on particular remapping type
# https://acme-climate.atlassian.net/wiki/spaces/Docs/pages/178848194/Transition+to+TempestRemap+for+Atmosphere+grids
# map_tag in comments is for E3SM naming convention map_src_to_dst_${map_tag}.20180301.nc
alg_opt='tempest'
wgt_typ='tempest'
elif [ ${alg_typ} = 'se2fv_flx' ] || [ ${alg_typ} = 'mono_se2fv' ] || [ ${alg_typ} = 'conservative_monotone_se2fv' ]; then # map_tag='mono'
wgt_opt_tps="--in_type cgll --in_np 4 --out_type fv --out_double --mono"
if [ -n "${gll_fl}" ]; then
wgt_opt_tps="--in_meta ${gll_fl} ${wgt_opt_tps}"
fi # !gll_fl
wgt_typ='tempest'
elif [ ${alg_typ} = 'se2fv_stt' ] || [ ${alg_typ} = 'highorder_se2fv' ] || [ ${alg_typ} = 'accurate_conservative_nonmonotone_se2fv' ]; then # map_tag='highorder'
wgt_opt_tps="--in_type cgll --in_np 4 --out_type fv --out_double"
if [ -n "${gll_fl}" ]; then
wgt_opt_tps="--in_meta ${gll_fl} ${wgt_opt_tps}"
fi # !gll_fl
wgt_typ='tempest'
elif [ ${alg_typ} = 'se2fv_alt' ] || [ ${alg_typ} = 'intbilin_se2fv' ] || [ ${alg_typ} = 'accurate_monotone_nonconservative_se2fv' ]; then # map_tag='intbilin'
wgt_opt_tps="--in_type cgll --in_np 4 --out_type fv --out_double --mono3 --noconserve"
if [ -n "${gll_fl}" ]; then
wgt_opt_tps="--in_meta ${gll_fl} ${wgt_opt_tps}"
fi # !gll_fl
wgt_typ='tempest'
elif [ ${alg_typ} = 'fv2se_flx' ] || [ ${alg_typ} = 'monotr_fv2se' ] || [ ${alg_typ} = 'conservative_monotone_fv2se' ]; then # map_tag='monotr'
# NB: Generate mono map for opposite direction regridding (i.e., reverse switches and grids), then transpose
wgt_opt_tps="--in_type cgll --in_np 4 --out_type fv --out_double --mono"
if [ -n "${gll_fl}" ]; then
wgt_opt_tps="--in_meta ${gll_fl} ${wgt_opt_tps}"
fi # !gll_fl
wgt_typ='tempest'
trn_map='Yes'
elif [ ${alg_typ} = 'fv2se_stt' ] || [ ${alg_typ} = 'highorder_fv2se' ] || [ ${alg_typ} = 'accurate_conservative_nonmonotone_fv2se' ]; then # map_tag='highorder'
wgt_opt_tps="--in_type fv --in_np 2 --out_type cgll --out_np 4 --out_double --volumetric"
if [ -n "${gll_fl}" ]; then
wgt_opt_tps="${wgt_opt_tps} --out_meta ${gll_fl}"
fi # !gll_fl
wgt_typ='tempest'
elif [ ${alg_typ} = 'fv2se_alt' ] || [ ${alg_typ} = 'mono_fv2se' ] || [ ${alg_typ} = 'conservative_monotone_fv2se_alt' ]; then # map_tag='mono'
wgt_opt_tps="--in_type fv --in_np 1 --out_type cgll --out_np 4 --out_double --mono --volumetric"
if [ -n "${gll_fl}" ]; then
wgt_opt_tps="${wgt_opt_tps} --out_meta ${gll_fl}"
fi # !gll_fl
wgt_typ='tempest'
else
echo "${spt_nm}: ERROR ${alg_typ} is not a valid remapping algorithm\n"
echo "${spt_nm}: HINT Valid ESMF remapping algorithms are bilinear,bln | conserve,cns | nearestdtos,nds,dtos | neareststod,nsd,stod | patch,pch\n"
echo "${spt_nm}: HINT Valid TempestRemap remapping options are tempest | se2fv_flx,mono_se2fv | se2fv_stt,highorder_se2fv | se2fv_alt,intbilin | fv2se_flx,monotr_fv2se | fv2se_stt,highorder_fv2se | fv2se_alt,mono_fv2se\n"
exit 1
fi # !alg_typ
if [ -n "${fl_fmt}" ]; then
if [ "${fl_fmt}" = '3' ] || [ "${fl_fmt}" = 'classic' ] || [ "${fl_fmt}" = 'netcdf3' ]; then
nco_fl_fmt='--fl_fmt=classic'
fi # !fl_fmt
if [ "${fl_fmt}" = '4' ] || [ "${fl_fmt}" = 'netcdf4' ] || [ "${fl_fmt}" = 'hdf5' ]; then
nco_fl_fmt='--fl_fmt=netcdf4'
wgt_opt_esmf="${wgt_opt_esmf} --netcdf4"
fi # !fl_fmt
if [ "${fl_fmt}" = '5' ] || [ "${fl_fmt}" = '64bit_data' ] || [ "${fl_fmt}" = 'cdf5' ]; then
nco_fl_fmt='--fl_fmt=64bit_data'
wgt_opt_esmf="${wgt_opt_esmf} --64bit_offset" # Change when ERWG supports CDF5
fi # !fl_fmt
if [ "${fl_fmt}" = '6' ] || [ "${fl_fmt}" = '64bit_offset' ] || [ "${fl_fmt}" = '64' ]; then
nco_fl_fmt='--fl_fmt=64bit_offset'
wgt_opt_esmf="${wgt_opt_esmf} --64bit_offset"
fi # !fl_fmt
if [ "${fl_fmt}" = '7' ] || [ "${fl_fmt}" = 'netcdf4_classic' ]; then
nco_fl_fmt='--fl_fmt=netcdf4_classic'
wgt_opt_esmf="${wgt_opt_esmf} --netcdf4" # Change when ERWG supports netCDF7
fi # !fl_fmt
nco_opt="${nco_opt} ${nco_fl_fmt}"
fi # !fl_fmt
if [ ${wgt_typ} = 'esmf' ]; then
wgt_cmd="${wgt_exe_esmf}"
wgt_exe="${wgt_exe_esmf}"
wgt_opt="${wgt_opt_esmf}"
else
wgt_cmd="${wgt_exe_tps}"
wgt_exe="${wgt_exe_tps}"
wgt_opt="${wgt_opt_tps}"
fi # !wgt_typ
# NB: Define after wgt_typ-block so user can override default options
if [ -n "${wgt_opt_usr}" ]; then
wgt_opt=${wgt_opt_usr}
fi # !wgt_usr
if [ -n "${wgt_usr}" ]; then
wgt_cmd=${wgt_usr}
fi # !wgt_usr
if [ -z "${drc_in}" ]; then
drc_in="${drc_pwd}"
else # !drc_in
drc_in_usr_flg='Yes'
fi # !drc_in
if [ -n "${in_fl}" ]; then
inp_aut='Yes'
fi # !in_fl
if [ -n "${job_usr}" ]; then
job_nbr="${job_usr}"
fi # !job_usr
if [ ${dbg_lvl} -ge 2 ]; then
nco_opt="-D ${dbg_lvl} ${nco_opt}"
fi # !dbg_lvl
if [ -n "${ppc_prc}" ]; then
nco_opt="${nco_opt} --ppc default=${ppc_prc}"
fi # !ppc_prc
if [ -n "${dfl_lvl}" ]; then
nco_opt="${nco_opt} --dfl_lvl=${dfl_lvl}"
fi # !dfl_lvl
if [ -n "${nco_usr}" ]; then
nco_opt="${nco_usr} ${nco_opt}"
fi # !var_lst
if [ -n "${gaa_sng}" ]; then
nco_opt="${nco_opt} ${gaa_sng}"
fi # !gaa_sng
if [ -n "${hdr_pad}" ]; then
nco_opt="${nco_opt} --hdr_pad=${hdr_pad}"
fi # !hdr_pad
if [ "${no_cll_msr}" = 'Yes' ]; then
nco_opt="${nco_opt} --no_cll_msr"
fi # !no_cll_msr
if [ "${no_frm_trm}" = 'Yes' ]; then
nco_opt="${nco_opt} --no_frm_trm"
fi # !no_frm_trm
if [ "${no_stg_grd}" = 'Yes' ]; then
rgr_opt="${rgr_opt} --rgr no_stagger"
fi # !no_stg_grd
if [ -n "${rnr_thr}" ]; then
if [ "${rnr_thr}" != 'off' ]; then
rgr_opt="${rgr_opt} --rnr_thr=${rnr_thr}"
fi # !rnr_thr
fi # !rnr_thr
if [ -n "${var_lst}" ]; then
nco_var_lst="-v ${var_lst}"
fi # !var_lst
if [ -n "${msk_dst}" ]; then
nco_msk_dst="--rgr msk_var=${msk_dst}"
fi # !msk_dst
if [ -n "${msk_out}" ]; then
nco_msk_out="--rgr msk_var=${msk_out}"
fi # !msk_out
if [ -n "${msk_src}" ]; then
nco_msk_src="--rgr msk_var=${msk_src}"
fi # !msk_src
if [ -n "${ugrid_fl}" ]; then
nco_ugrid_fl="--rgr ugrid=${ugrid_fl}"
fi # !ugrid_fl
if [ -n "${var_rgr}" ]; then
nco_var_rgr="--rgr_var=${var_rgr}"
fi # !var_rgr
if [ -n "${xtn_var}" ]; then
rgr_opt="${rgr_opt} --xtn=${xtn_var}"
fi # !var_lst
if [ -n "${out_fl}" ]; then
out_usr_flg='Yes'
fi # !out_fl
if [ -n "${par_typ}" ]; then
if [ "${par_typ}" != 'bck' ] && [ "${par_typ}" != 'mpi' ] && [ "${par_typ}" != 'nil' ]; then
echo "ERROR: Invalid -p par_typ option = ${par_typ}"
echo "HINT: Valid par_typ arguments are 'bck', 'mpi', and 'nil'"
exit 1
fi # !par_typ
fi # !par_typ
if [ "${par_typ}" = 'bck' ]; then
par_opt=' &'
elif [ "${par_typ}" = 'mpi' ]; then
mpi_flg='Yes'
par_opt=' &'
fi # !par_typ
if [ -n "${prc_typ}" ]; then
if [ "${prc_typ}" != 'airs' ] && [ "${prc_typ}" != 'alm' ] && [ "${prc_typ}" != 'clm' ] && [ "${prc_typ}" != 'cice' ] && [ "${prc_typ}" != 'hirdls' ] && [ "${prc_typ}" != 'mls' ] && [ "${prc_typ}" != 'mod04' ] && [ "${prc_typ}" != 'mpas' ] && [ "${prc_typ}" != 'nil' ] && [ "${prc_typ}" != 'sgs' ] ; then
echo "ERROR: Invalid -P prc_typ option = ${prc_typ}"
echo "HINT: Valid prc_typ arguments are 'airs', 'alm', 'clm', 'cice', 'hirdls', 'mls', 'mod04', 'mpas', 'nil', and 'sgs'"
exit 1
fi # !prc_typ
fi # !prc_typ
if [ "${prc_typ}" = 'airs' ]; then
pdq_opt='-a StdPressureLev,GeoTrack,GeoXTrack'
fi # !airs
if [ "${prc_typ}" = 'hirdls' ]; then
pdq_opt='-a Pressure,Latitude,lon'
fi # !hirdls
if [ "${prc_typ}" = 'mls' ]; then
pdq_opt='-a CO_Pressure,CO_Latitude,lon'
fi # !mls
if [ "${prc_typ}" = 'mod04' ]; then
pdq_opt='-U'
hnt_dst='--dst_regional'
fi # !mod04
if [ "${prc_typ}" = 'mpas' ]; then
# pdq_opt='-a Time,nVertLevels,maxEdges,MaxEdges2,nEdges,nCells' # Ocean
# pdq_opt='-a Time,nCategories,ONE,nEdges,nCells' # SeaIce
# pdq_opt='-a Time,nCategories,TWO,nEdges,nCells' # LandIce
pdq_opt='-a Time,nVertLevels,maxEdges,MaxEdges2,nCategories,ONE,nEdges,nCells' # Ocean and Ice in one swell foop
if [ -n "${rnr_thr}" ]; then
# Setting rnr_thr='off' in MPAS mode turns-off renormalization
if [ "${rnr_thr}" != 'off' ]; then
rgr_opt="${rgr_opt} --rnr_thr=${rnr_thr}"
fi # !rnr_thr
else
rgr_opt="${rgr_opt} --rnr_thr=0.0"
fi # !rnr_thr
fi # !mpas
if [ "${prc_typ}" = 'alm' ] || [ "${prc_typ}" = 'clm' ]; then
# Set ALM/CLM-specific options first, then change prc_typ to sgs
rds_rth='6.37122e6' # [m] Radius of Earth in ALM/CLM (SHR_CONST_REARTH)
sgs_frc='landfrac'
sgs_msk='landmask'
sgs_nrm='1.0'
prc_alm='Yes'
prc_typ='sgs'
fi # !alm, !clm
if [ "${prc_typ}" = 'cice' ]; then
# Set CICE-specific options first, then change prc_typ to sgs
rds_rth='6371229.0' # [m] Radius of Earth in MPAS-CICE (global attribute sphere_radius)
sgs_frc='aice'
sgs_msk='tmask'
sgs_nrm='100.0'
prc_cice='Yes'
prc_typ='sgs'
fi # !alm
if [ "${prc_typ}" = 'sgs' ]; then
nco_dgn_area='--rgr diagnose_area'
wgt_opt_esmf='--user_areas --ignore_unmapped'
wgt_opt=${wgt_opt_esmf}
fi # !sgs
if [ -n "${thr_usr}" ]; then
thr_nbr="${thr_usr}"
fi # !thr_usr
if [ -n "${dst_fl}" ]; then
if [ ! -f "${dst_fl}" ]; then
echo "ERROR: Unable to find specified destination-file ${dst_fl}"
echo "HINT: Supply the full path-name for the destination-file"
exit 1
fi # ! -f
dst_usr_flg='Yes'
fi # !dst_fl
if [ -n "${grd_dst}" ]; then
if [ ! -f "${grd_dst}" ]; then
echo "ERROR: Unable to find specified destination grid-file ${grd_dst}"
echo "HINT: Supply the full path-name for the destination grid, or generate one automatically with -G"
exit 1
fi # ! -f
grd_dst_usr_flg='Yes'
else
grd_dst=${grd_dst_dfl} # [sng] Grid-file default
fi # !grd_dst
if [ -n "${grd_src}" ]; then
if [ ! -f "${grd_src}" ]; then
echo "ERROR: Unable to find specified source grid-file ${grd_src}"
exit 1
fi # ! -f
grd_src_usr_flg='Yes'
else
grd_src=${grd_src_dfl} # [sng] Grid-file default
fi # !grd_src
if [ -z "${grd_sng}" ]; then
grd_sng_dfl="--rgr grd_ttl='Default internally-generated grid' --rgr scrip=${grd_dst_dfl} --rgr latlon=100,100 --rgr snwe=30.0,70.0,-130.0,-90.0" # [sng] Grid string default
grd_sng="${grd_sng_dfl}"
else
grd_sng_usr_flg='Yes'
fi # !grd_sng
if [ "${dst_usr_flg}" = 'Yes' ] || [ "${grd_sng_usr_flg}" = 'Yes' ] || [ "${grd_dst_usr_flg}" = 'Yes' ] || [ "${grd_src_usr_flg}" = 'Yes' ]; then
# Specified map-file will be created if -d, -G, -g, or -s was specified
map_mk='Yes'
fi # !map_mk
if [ -n "${map_fl}" ]; then
map_usr_flg='Yes'
if [ "${map_mk}" = 'Yes' ]; then
# Confirm before overwriting maps
if [ -f "${map_fl}" ]; then
# 20160803: fxm invoke iff in interactive shell (block hangs on read() in non-interactive shells)
# if [ -t 0 ] || [ ! -p /dev/stdin ]; then
# if [ -n "${TERM}" ]; then
# if [ -n "${PS1}" ]; then
if [ 1 -eq 0 ]; then
rsp_kbd_nbr=0
while [ ${rsp_kbd_nbr} -lt 10 ]; do
echo "WARNING: Map-file ${map_fl} already exists and will be over-written."
read -p "Continue (y/n)? " rsp_kbd
let rsp_kbd_nbr+=1
case "${rsp_kbd}" in
N*|n*) exit 1 ;;
Y*|y*) break ;;
*) continue ;;
esac
done # !rsp_kbd_nbr
if [ ${rsp_kbd_nbr} -ge 10 ]; then
echo "ERROR: Too many invalid responses, exiting"
exit 1
fi # !rsp_kbd_nbr
fi # !0
fi # !map_fl
else # !map_mk
if [ ! -f "${map_fl}" ]; then
echo "ERROR: Unable to find specified regrid map ${map_fl}"
echo "HINT: Supply a valid map-file (weight-file) name or supply the grid files or data files and let ncremap create a mapfile for you"
exit 1
fi # ! -f
fi # !map_mk
else # !map_fl
if [ "${wgt_typ}" = 'esmf' ]; then
map_fl_dfl="${drc_tmp}/ncremap_tmp_map_${wgt_typ}_${alg_opt}.nc${unq_sfx}" # [sng] Map-file default
fi # !esmf
if [ "${wgt_typ}" = 'tempest' ]; then
map_fl_dfl="${drc_tmp}/ncremap_tmp_map_${wgt_typ}.nc${unq_sfx}" # [sng] Map-file default
fi # !tempest
map_fl=${map_fl_dfl}
fi # !map_fl
map_rsl_fl=${map_fl}
if [ "${map_mk}" = 'Yes' ] && [ "${wgt_typ}" = 'tempest' ]; then
msh_fl_dfl="${drc_tmp}/ncremap_tmp_msh_ovr_${wgt_typ}.g${unq_sfx}" # [sng] Mesh-file default
msh_fl=${msh_fl_dfl}
if [ "${trn_map}" = 'Yes' ]; then
map_trn_fl="${drc_tmp}/ncremap_tmp_map_trn_${wgt_typ}.nc${unq_sfx}" # [sng] Map-file transpose default
map_rsl_fl=${map_trn_fl}
fi # !trn_map
fi # !tempest
# Read files from stdin pipe, positional arguments, or directory glob
# Code block taken from ncclimo
# ncclimo sets inp_aut flag when file list is automatically (i.e., internally) generated
# ncremap uses convention that input files specified with -i set inp_aut flag
# That way, ncremap code block looks closer to ncclimo without introducing a new "inp_cmd" flag
#printf "dbg: inp_aut = ${inp_aut}\n"
#printf "dbg: inp_glb = ${inp_glb}\n"
#printf "dbg: inp_psn = ${inp_psn}\n"
#printf "dbg: inp_std = ${inp_std}\n"
if [ ${inp_aut} = 'No' ] && [ ${inp_psn} = 'No' ] && [ ${inp_std} = 'No' ] && [ "${drc_in_usr_flg}" = 'Yes' ]; then
inp_glb='Yes'
fi # !inp_psn, !inp_std
if [ "${map_mk}" != 'Yes' ] && [ ${inp_aut} = 'No' ] && [ ${inp_glb} = 'No' ] && [ ${inp_psn} = 'No' ] && [ ${inp_std} = 'No' ]; then
echo "${spt_nm}: ERROR Specify input file(s) with -i \$in_fl or with -I \$drc_in or with positional argument(s) or with stdin"
if [ ${bch_pbs} = 'Yes' ]; then
echo "${spt_nm}: HINT PBS batch job environment detected, pipe to stdin not allowed, try positional arguments instead"
else # !bch_pbs
echo "${spt_nm}: HINT Pipe input file list to stdin with, e.g., 'ls *.nc | ${spt_nm}'"
fi # !bch_pbs
exit 1
fi # !sbs_flg
if [ ${inp_aut} = 'Yes' ]; then
# Single file argument
fl_in[0]=${in_fl}
fl_nbr=1
fi # !inp_aut
if [ ${inp_glb} = 'Yes' ]; then
for fl in "${drc_in}"/*.nc "${drc_in}"/*.nc3 "${drc_in}"/*.nc4 "${drc_in}"/*.cdf "${drc_in}"/*.hdf "${drc_in}"/*.he5 "${drc_in}"/*.h5 ; do
if [ -f "${fl}" ]; then
fl_in[${fl_nbr}]=${fl}
let fl_nbr=${fl_nbr}+1
fi # !file
done
fi # !inp_glb
if [ ${inp_psn} = 'Yes' ]; then
if [ ${psn_nbr} -eq 1 ]; then
fl_in[0]=${1}
fl_nbr=1
elif [ ${psn_nbr} -eq 2 ]; then
if [ -z "${out_fl}" ]; then
fl_in[0]=${1}
out_fl=${2}
out_usr_flg='Yes'
fl_nbr=1
else # !out_fl
echo "ERROR: Output file specified with -o (${out_fl}) conflicts with second positional argument ${2}"
echo "HINT: Use -o out_fl or positional argument, not both"
exit 1
fi # !out_fl
elif [ ${psn_nbr} -ge 3 ]; then
for ((psn_idx=1;psn_idx<=psn_nbr;psn_idx++)); do
fl_in[(${psn_idx}-1)]=${!psn_idx}
fl_nbr=${psn_nbr}
done # !psn_idx
fi # !psn_nbr
fi # !inp_psn
if [ ${inp_std} = 'Yes' ]; then
# Input awaits on unit 0, i.e., on stdin
while read -r line; do # NeR05 p. 179
fl_in[${fl_nbr}]=${line}
let fl_nbr=${fl_nbr}+1
done < /dev/stdin
fi # !inp_std
if [ "${mpi_flg}" = 'Yes' ]; then
if [ -n "${COBALT_NODEFILE}" ]; then
nd_fl="${COBALT_NODEFILE}"
elif [ -n "${PBS_NODEFILE}" ]; then
nd_fl="${PBS_NODEFILE}"
elif [ -n "${SLURM_NODELIST}" ]; then
# SLURM returns compressed lists (e.g., "nid00[076-078,559-567]")
# Convert this to file with uncompressed list (like Cobalt, PBS)
# http://www.ceci-hpc.be/slurm_faq.html#Q12
nd_fl='ncremap.slurm_nodelist'
nd_lst=`scontrol show hostname ${SLURM_NODELIST}`
echo ${nd_lst} > ${nd_fl}
else
echo "ERROR: MPI job unable to find node list"
echo "HINT: ${spt_nm} uses first node list found in \$COBALT_NODEFILE (= \"${COBALT_NODEFILE}\"), \$PBS_NODEFILE (= \"${PBS_NODEFILE}\"), \$SLURM_NODELIST (= \"${SLURM_NODELIST}\")"
exit 1
fi # !PBS
if [ -n "${nd_fl}" ]; then
# NB: nodes are 0-based, e.g., [0..11]
nd_idx=0
for nd in `cat ${nd_fl} | uniq` ; do
nd_nm[${nd_idx}]=${nd}
let nd_idx=${nd_idx}+1
done # !nd
nd_nbr=${#nd_nm[@]}
for ((fl_idx=0;fl_idx<fl_nbr;fl_idx++)); do
case "${HOSTNAME}" in
# 20160502: Remove limits on tasks per node so round-robin algorithm can schedule multiple jobs on same node
cori* | edison* | nid* )
# 20160502: Non-interactive batch jobs at NERSC return HOSTNAME as nid*, not cori* or edison*
# NB: NERSC staff says srun automatically assigns to unique nodes even without "-L $node" argument?
cmd_mpi[${fl_idx}]="srun --nodelist ${nd_nm[$((${fl_idx} % ${nd_nbr}))]} --nodes=1" ; ;; # NERSC
# cmd_mpi[${fl_idx}]="srun --nodelist ${nd_nm[$((${fl_idx} % ${nd_nbr}))]} --nodes=1 --ntasks=1" ; ;; # NERSC
hopper* )
# NB: NERSC migrated from aprun to srun in 201601. Hopper commands will soon be deprecated.
cmd_mpi[${fl_idx}]="aprun -L ${nd_nm[$((${fl_idx} % ${nd_nbr}))]} -n 1" ; ;; # NERSC
* )
cmd_mpi[${fl_idx}]="mpirun -H ${nd_nm[$((${fl_idx} % ${nd_nbr}))]} -n 1" ; ;; # Other (Cobalt)
# cmd_mpi[${fl_idx}]="mpirun -H ${nd_nm[$((${fl_idx} % ${nd_nbr}))]} -npernode 1 -n 1" ; ;; # Other
esac # !HOSTNAME
done # !fl_idx
if [ -n "${SLURM_NODELIST}" ]; then
/bin/rm -f ${nd_fl}
fi # !SLURM
else # !nd_fl
mpi_flg='No'
for ((fl_idx=0;fl_idx<fl_nbr;fl_idx++)); do
cmd_mpi[${fl_idx}]=""
done # !fl_idx
fi # !nd_fl
if [ -z "${job_usr}" ]; then
job_nbr=${nd_nbr}
fi # !job_usr
if [ -z "${thr_usr}" ]; then
if [ -n "${PBS_NUM_PPN}" ]; then
# NB: use export OMP_NUM_THREADS when thr_nbr > 8
# thr_nbr=${PBS_NUM_PPN}
thr_nbr=$((PBS_NUM_PPN > 8 ? 8 : PBS_NUM_PPN))
fi # !pbs
fi # !thr_usr
fi # !mpi_flg
# Print initial state
if [ ${dbg_lvl} -ge 2 ]; then
printf "dbg: alg_opt = ${alg_opt}\n"
printf "dbg: cln_flg = ${cln_flg}\n"
printf "dbg: dbg_lvl = ${dbg_lvl}\n"
printf "dbg: dfl_lvl = ${dfl_lvl}\n"
printf "dbg: drc_in = ${drc_in}\n"
printf "dbg: drc_out = ${drc_out}\n"
printf "dbg: drc_tmp = ${drc_tmp}\n"
printf "dbg: dst_fl = ${dst_fl}\n"
printf "dbg: fl_fmt = ${fl_fmt}\n"
printf "dbg: fl_nbr = ${fl_nbr}\n"
printf "dbg: gaa_sng = ${gaa_sng}\n"
printf "dbg: gll_fl = ${gll_fl}\n"
printf "dbg: grd_dst = ${grd_dst}\n"
printf "dbg: grd_sng = ${grd_sng}\n"
printf "dbg: grd_src = ${grd_src}\n"
printf "dbg: inp_aut = ${inp_aut}\n"
printf "dbg: inp_glb = ${inp_glb}\n"
printf "dbg: inp_psn = ${inp_psn}\n"
printf "dbg: inp_std = ${inp_std}\n"
printf "dbg: hdr_pad = ${hdr_pad}\n"
printf "dbg: hrd_pth = ${hrd_pth}\n"
printf "dbg: job_nbr = ${job_nbr}\n"
printf "dbg: in_fl = ${in_fl}\n"
printf "dbg: map_fl = ${map_fl}\n"
printf "dbg: map_mk = ${map_mk}\n"
printf "dbg: mlt_map = ${mlt_map_flg}\n"
printf "dbg: mpi_flg = ${mpi_flg}\n"
printf "dbg: msk_dst = ${msk_dst}\n"
printf "dbg: msk_out = ${msk_out}\n"
printf "dbg: msk_src = ${msk_src}\n"
printf "dbg: nco_opt = ${nco_opt}\n"
printf "dbg: nd_nbr = ${nd_nbr}\n"
printf "dbg: out_fl = ${out_fl}\n"
printf "dbg: par_typ = ${par_typ}\n"
printf "dbg: ppc_prc = ${ppc_prc}\n"
printf "dbg: rgr_opt = ${rgr_opt}\n"
printf "dbg: rnr_thr = ${rnr_thr}\n"
printf "dbg: sgs_frc = ${sgs_frc}\n"
printf "dbg: sgs_msk = ${sgs_msk}\n"
printf "dbg: sgs_nrm = ${sgs_nrm}\n"
printf "dbg: spt_pid = ${spt_pid}\n"
printf "dbg: thr_nbr = ${thr_nbr}\n"
printf "dbg: ugrid_fl = ${ugrid_fl}\n"
printf "dbg: unq_sfx = ${unq_sfx}\n"
printf "dbg: var_lst = ${var_lst}\n"
printf "dbg: var_rgr = ${var_rgr}\n"
printf "dbg: wgt_cmd = ${wgt_cmd}\n"
printf "dbg: wgt_opt = ${wgt_opt}\n"
printf "dbg: wgt_usr = ${wgt_usr}\n"
printf "dbg: Will regrid ${fl_nbr} files:\n"
for ((fl_idx=0;fl_idx<${fl_nbr};fl_idx++)); do
printf "${fl_in[${fl_idx}]}\n"
done # !fl_idx
fi # !dbg
if [ ${dbg_lvl} -ge 2 ]; then
if [ ${mpi_flg} = 'Yes' ]; then
for ((nd_idx=0;nd_idx<${nd_nbr};nd_idx++)); do
printf "dbg: nd_nm[${nd_idx}] = ${nd_nm[${nd_idx}]}\n"
done # !nd
fi # !mpi
fi # !dbg
if [ ${dbg_lvl} -ge 2 ]; then
psn_nbr=$#
printf "dbg: Found ${psn_nbr} positional parameters (besides \$0):\n"
for ((psn_idx=1;psn_idx<=psn_nbr;psn_idx++)); do
printf "dbg: psn_arg[${psn_idx}] = ${!psn_idx}\n"
done # !psn_idx
fi # !dbg
# Create output directory
if [ -n "${drc_out}" ]; then
mkdir -p ${drc_out}
fi # !drc_out
if [ -n "${drc_tmp}" ]; then
mkdir -p ${drc_tmp}
fi # !drc_tmp
# Human-readable summary
date_srt=$(date +"%s")
if [ ${vrb_lvl} -ge ${vrb_4} ]; then
printf "NCO regridder invoked with command:\n"
echo "${cmd_ln}"
fi # !vrb_lvl
if [ -f 'PET0.RegridWeightGen.Log' ]; then
if [ ${vrb_lvl} -ge ${vrb_4} ]; then
printf "${spt_nm}: Removing PET0.RegridWeightGen.Log file and any other PET0.* files from current directory before running\n"
fi # !vrb_lvl
/bin/rm -f PET0.*
fi # !PETO
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Started processing at `date`.\n"
printf "Running remap script ${spt_nm} from directory ${drc_spt}\n"
printf "NCO binaries version ${nco_vrs} from directory ${drc_nco}\n"
printf "Input files in or relative to directory ${drc_in}\n"
printf "Intermediate/temporary files written to directory ${drc_tmp}\n"
printf "Output files to directory ${drc_out}\n"
fi # !vrb_lvl
if [ "${map_mk}" != 'Yes' ] && [ "${map_usr_flg}" = 'Yes' ] && [ -n "${wgt_usr}" ]; then
printf "${spt_nm}: ERROR Specifying both '-m map_fl' and '-w wgt_cmd' is only allowed when creating a map (weight generator is superfluous when user supplies map)\n"
exit 1
fi # wgt_usr
if [ "${dst_usr_flg}" = 'Yes' ]; then
if [ "${grd_dst_usr_flg}" = 'Yes' ]; then
printf "${spt_nm}: ERROR Specify either '-d dst_fl' or '-g grd_dst', not both\n"
exit 1
fi # !grd_dst_usr_flg
fi # !dst_usr_flg
if [ "${dst_usr_flg}" != 'Yes' ] && [ "${grd_dst_usr_flg}" != 'Yes' ] && [ "${map_usr_flg}" != 'Yes' ] && [ "${grd_sng_usr_flg}" != 'Yes' ]; then
printf "${spt_nm}: ERROR Must use one of '-d dst_fl', '-g grd_dst', '-G grd_sng', or '-m map_fl'\n"
exit 1
fi # !dst_usr_flg
# Generate destination grid, if necessary, once (only) before loop over input files
# Block 1: Destination grid
# Generate destination grid at most one-time (unlike source grid)
# Eventually we will allow destination grid to be provided as grid-file, map-file, or data-file without a switch
# Currently we require user to know (and specify) means by which destination grid is provided
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
if [ ${fl_nbr} -eq 0 ]; then
printf "Map-only run: no input data detected therefore will exit after generating map\n"
fi # !fl_nbr
if [ -n "${pdq_opt}" ] && [ -n "${pdq_typ}" ]; then
printf "Input data shaped in \"${prc_typ}\"-order, will permute with \"ncpdq ${pdq_opt}\"\n"
fi # !pdq_opt
if [ -n "${pdq_opt}" ]; then
if [ -n "${pdq_typ}" ]; then
printf "Input data shaped in \"${prc_typ}\"-order, will first permute with \"ncpdq ${pdq_opt}\"\n"
else
printf "Input assumed to contain packed data, will first unpack with \"ncpdq ${pdq_opt}\"\n"
fi # !pdq_typ
fi # !pdq_opt
if [ "${prc_typ}" = 'mpas' ]; then
printf "Input assumed to be MPAS data: will renormalize (with --rnr=0.0) regridding\n"
if [ "${clm_flg}" = 'No' ]; then
printf "Input assumed to be barenaked of attributes: will annotate NC_DOUBLE variables with _FillValue = ${mss_val} prior to regridding\n"
fi # !clm_flg
fi # !mpas
if [ "${prc_typ}" = 'sgs' ]; then
printf "Input assumed to contain sub-gridscale (SGS, aka \"fractional area\") data: Intensive values valid for gridcell fraction specified by \"${sgs_frc}\" variable, not for entire gridcell_area (except where ${sgs_frc} = 1.0). Will first conservatively regrid ${sgs_frc}, and then normalize subsequent regridding to conserve ${sgs_frc}*gridcell_area*field_value (not gridcell_area*field_value).\n"
if [ ${fl_nbr} -eq 0 ] || [ "${map_usr_flg}" = 'Yes' ]; then
printf "${spt_nm}: ERROR Sub-gridscale handling currently requires at least one data file (for the surface fractions of each gridcell)\n"
echo "${spt_nm}: HINT Supply a data file with \"-i fl_in\""
exit 1
fi # !fl_nbr
if [ "${wgt_typ}" = 'tempest' ]; then
printf "${spt_nm}: ERROR Sub-gridscale handling currently does not support TempestRemap.\n"
echo "${spt_nm}: HINT Use ESMF weight-generator (and ask Charlie to implement SGS for Tempest)"
exit 1
fi # !wgt_typ
if [ "${grd_src_usr_flg}" != 'Yes' ]; then
printf "${spt_nm}: ERROR Sub-gridscale handling currently requires the user to specify the SCRIP source grid-file. Moreover, the source grid-file must include the (normally non-essential) grid_area field. It is infeasible to permit SGS source-grid inferral, because weight-generators assume great circle arcs but 2D-grids usually have small-circles in latitude, and this can lead to significant area mis-matches. Despite this, sub-gridscale handling is happy to infer destination (not source) grids.\n"
echo "${spt_nm}: HINT Supply source grid-file with \"-s grd_src\". If the source grid-file is unavailable, first multiply sub-grid fields by ${sgs_frc} (with, e.g., ncap2 -s \"foo*=${sgs_frc};\" in.nc out.nc) and then regrid as normal without invoking sub-gridscale handling, i.e., omit the '-P sgs' and '--sgs_*' options."
exit 1
# 20170511: Inferring source grids leads to ~2% biases with conservative regridding and 2D source grids
# printf "${spt_nm}: Sub-gridscale handling will attempt to infer the source SCRIP grid-file from the input data file. This will only work for rectangular 2D data files, because SGS requires the source grid-file to contain the (normally non-essential) grid_area field for the input grid.\n"
fi # !grd_src_usr_flg
if [ "${grd_dst_usr_flg}" != 'Yes' ]; then
printf "${spt_nm}: Sub-gridscale handling will attempt to infer the destination SCRIP grid-file from the provided output data file template (which will not be touched).\n"
fi # !grd_dst_usr_flg
if [ "${map_usr_flg}" = 'Yes' ]; then
printf "${spt_nm}: ERROR Sub-grid handling forbids specification of a precomputed map-file. Sub-grid handling must generate map-files from specially pre-processed SCRIP grid-files. Allowing pre-computed map-files risks users inadvertently supplying incorrect map-files. The supplied or inferred SCRIP grid-files must include the (normally non-essential) grid_area field, which ${spt_nm} can normally infer from rectangular 2-D datafiles, though not from 1-D (unstructured) datafiles.\n"
echo "${spt_nm}: HINT Remove map-file specification by eliminating the \"-m map_fl\" option"
exit 1
fi # !fl_nbr
fi # !sgs
fi # !vrb_lvl
if [ "${map_mk}" != 'Yes' ] && [ "${map_usr_flg}" = 'Yes' ]; then
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Source and destination grids will both be read from supplied map-file\n"
fi # !vrb_lvl
else # !map_usr_flg
fl_idx=0 # [idx] Current file index
if [ "${dst_usr_flg}" = 'Yes' ]; then
# Block 1 Loop 1: Generate, check, and store (but do not yet execute) commands
# Infer destination grid-file from data file
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Destination grid will be inferred from data-file\n"
fi # !vrb_lvl
cmd_dst[${fl_idx}]="ncks ${nco_opt} --rgr infer --rgr hnt_dst=${hnt_dst_fl} ${nco_dgn_area} ${nco_msk_dst} ${nco_var_rgr} --rgr scrip=${grd_dst} ${dst_fl} ${tmp_out_fl}"
else # !dst_usr_flg
if [ "${grd_dst_usr_flg}" = 'Yes' ]; then
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Destination grid supplied by user\n"
fi # !vrb_lvl
else
if [ "${grd_sng_usr_flg}" = 'Yes' ]; then
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Destination grid will be generated from NCO grid string ${grd_sng}\n"
fi # !vrb_lvl
cmd_dst[${fl_idx}]="ncks ${nco_opt} ${grd_sng} ${fl_in[0]} ${tmp_out_fl}"
else
printf "${spt_nm}: ERROR Grid string grd_sng not provided\n"
exit 1
fi # !grd_sng_usr_flg
fi # !grd_dst_usr_flg
fi # !dst_usr_flg
if [ "${dst_usr_flg}" = 'Yes' ] || [ "${grd_dst_usr_flg}" != 'Yes' ]; then
# Block 1 Loop 2: Execute and/or echo commands
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_dst[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_dst[${fl_idx}]}
if [ $? -ne 0 ]; then
printf "${spt_nm}: ERROR Failed to infer destination grid. Debug this:\n${cmd_dst[${fl_idx}]}\n"
exit 1
fi # !err
if [ "${grd_sng_usr_flg}" = 'Yes' ]; then
/bin/rm -f ${tmp_out_fl}
fi # !grd_sng_usr_flg
fi # !dbg
fi # !dst_usr_flg || grd_dst_usr_flg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Weight-generation type: ${wgt_typ}\n"
fi # !vrb_lvl
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Algorithm used to generate weights in map-file is: ${alg_opt}\n"
printf "Will generate mapping weights and map-file with \'${wgt_cmd}\'\n"
fi # !vrb_lvl
command -v ${wgt_exe} 2>&1 > /dev/null || { printf "${spt_nm}: ERROR cannot find weight-generation command executable ${wgt_exe}. Please install the executable, or change your PATH to find it.\n${spt_nm}: HINT ESMF_RegridWeightGen is often provided in NCL packages. Tempest executables must be installed from source (https://github.com/ClimateGlobalChange/tempestremap).\n"; exit 1; }
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
if [ ${fl_nbr} -ge 2 ]; then
if [ "${mlt_map_flg}" = 'Yes' ]; then
printf "Input files assumed to use unique input grids\nOne source grid-file will be inferred and one map-file generated per input file\n"
else # !mlt_map_flg
printf "Input files assumed to use same input grid\nOnly one source grid-file and one map-file will be generated\n"
fi # !mlt_map_flg
fi # !fl_nbr
fi # !vrb_lvl
fi # !map_usr
if [ "${prc_typ}" = 'sgs' ]; then
fl_idx=0
grd_dst_sgs="${drc_tmp}/ncremap_tmp_grd_dst_sgs.nc${unq_sfx}" # [sng] Fractional destination grid-file
grd_src_sgs="${drc_tmp}/ncremap_tmp_grd_src_sgs.nc${unq_sfx}" # [sng] Fractional source grid-file
frc_in_sgs="${drc_tmp}/ncremap_tmp_frc_in_sgs.nc${unq_sfx}" # [sng] Sub-grid fraction on input data grid
frc_out_sgs="${drc_tmp}/ncremap_tmp_frc_out_sgs.nc${unq_sfx}" # [sng] Sub-grid fraction on output data grid
if [ "${grd_src_usr_flg}" != 'Yes' ]; then
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Source grid will be inferred from data-file\n"
if [ ${fl_nbr} -ge 2 ]; then
printf "Sub-grid mode assumes all input data-files on same grid as first file, so only one source grid-file will be inferred, and only one map-file will be generated, and it will be re-used\n"
fi # !fl_nbr
fi # !vrb_lvl
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Infer source grid-file from input data file...\n"
fi # !vrb_lvl
cmd_src[${fl_idx}]="ncks ${nco_opt} --rgr infer --rgr hnt_src=${hnt_src_fl} ${nco_dgn_area} ${nco_msk_src} ${nco_ugrid_fl} ${nco_var_rgr} --rgr scrip=${grd_src} ${fl_in[${fl_idx}]} ${tmp_out_fl}"
# Block 2 Loop 2: Execute and/or echo commands
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_src[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_src[${fl_idx}]}
if [ $? -ne 0 ]; then
printf "${spt_nm}: ERROR Failed to infer source grid. Debug this:\n${cmd_src[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !grd_src
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Duplicate destination grid-file for modification into fractional destination grid-file...\n"
fi # !vrb_lvl
cmd_cp_dst[${fl_idx}]="/bin/cp -f ${grd_dst} ${grd_dst_sgs}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_cp_dst[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_cp_dst[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${grd_dst_sgs} ]; then
printf "${spt_nm}: ERROR Failed to duplicate destination grid-file to fractional destination grid-file. Debug this:\n${cmd_cp_dst[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Duplicate source grid for modification into fractional source grid-file...\n"
fi # !vrb_lvl
cmd_cp_src[${fl_idx}]="/bin/cp -f ${grd_src} ${grd_src_sgs}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_cp_src[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_cp_src[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${grd_src_sgs} ]; then
printf "${spt_nm}: ERROR Failed to duplicate source grid to fractional source grid-file. Debug this:\n${cmd_cp_src[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Append sub-grid fraction from data-file to fractional source grid-file\n"
fi # !vrb_lvl
cmd_lnd_src[${fl_idx}]="ncks -A -C -v ${sgs_frc} ${fl_in[${fl_idx}]} ${grd_src_sgs}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_lnd_src[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_lnd_src[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${grd_src_sgs} ]; then
printf "${spt_nm}: ERROR Failed to append sub-grid fraction from data file to fractional source grid-file. Debug this:\n${cmd_lnd_src[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Derive fraction, mask, and area in fractional source grid-file...\n"
fi # !vrb_lvl
# 0. Normalize sub-grid fraction (e.g., from percent to fraction) if necessary
# 1. Eliminate _FillValue and missing_value attributes before using where() which would evaluate _FillValue as false, and necessitate using a weird where() condition
# 2. Set (formerly) missing values to 0 sub-grid fraction
# 3. Set 0 sub-grid fraction to 0 imask
# 4. Compute active grid area
cmd_wheresrc[${fl_idx}]="ncap2 -O -s '${sgs_frc}=${sgs_frc}; if(${sgs_nrm} != 1.0){${sgs_frc}/=${sgs_nrm}; ${sgs_frc}@units=\"1\";} if(${sgs_frc}@missing_value.exists()) ram_delete(${sgs_frc}@missing_value); delete_miss(${sgs_frc}); where(${sgs_frc} > 1.0f) ${sgs_frc}=0.0f; where(${sgs_frc} == 0.0f) grid_imask=0; grid_area*=${sgs_frc}' ${grd_src_sgs} ${grd_src_sgs}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_wheresrc[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_wheresrc[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${grd_src_sgs} ]; then
printf "${spt_nm}: ERROR Failed to derive fraction, mask, and area in fractional source grid-file. Debug this:\n${cmd_wheresrc[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Create sub-grid fraction ${sgs_frc} data file for regridding...\n"
fi # !vrb_lvl
cmd_lnd_in[${fl_idx}]="ncks -O -v ${sgs_frc} ${grd_src_sgs} ${frc_in_sgs}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_lnd_in[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_lnd_in[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${frc_in_sgs} ]; then
printf "${spt_nm}: ERROR Failed to extract sub-grid fraction from fractional source grid-file. Debug this:\n${cmd_lnd_in[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Regrid sub-grid fraction ${sgs_frc} to destination grid...\n"
fi # !vrb_lvl
# NB: Do not regrid sub-grid mask as it is extensive and may contain _FillValue (ALM/CLM landmask does)
cmd_lnd_rmp[${fl_idx}]="ncremap --vrb=0 -a ${alg_opt} -v ${sgs_frc} -i ${frc_in_sgs} -s ${grd_src} -g ${grd_dst} -o ${frc_out_sgs}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_lnd_rmp[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_lnd_rmp[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${frc_out_sgs} ]; then
printf "${spt_nm}: ERROR Failed to regrid sub-grid fraction. Debug this:\n${cmd_lnd_rmp[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Derive sub-grid mask ${sgs_msk} from regridded sub-grid fraction...\n"
fi # !vrb_lvl
# Allow for possibility that sgs_frc is 3D (time,lat,lon) as in CICE
# And be CAREFUL changing this
cmd_msk[${fl_idx}]="ncap2 -O -s 'if(${sgs_frc}.ndims() < 3) sgsarea=${sgs_frc}*area; else sgsarea=${sgs_frc}(0,:,:);${sgs_msk}=0*int(sgsarea);where(sgsarea > 0) ${sgs_msk}=1; elsewhere ${sgs_msk}=0;${sgs_msk}@long_name=\"surface mask (0=invalid and 1=valid)\";if(${sgs_msk}@cell_measures.exists()) ram_delete(${sgs_msk}@cell_measures)' ${frc_out_sgs} ${frc_out_sgs}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_msk[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_msk[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${frc_out_sgs} ]; then
printf "${spt_nm}: ERROR Failed to derive mask from regridded sub-grid fraction. Debug this:\n${cmd_msk[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Append regridded sub-grid fraction to destination fractional grid-file...\n"
fi # !vrb_lvl
cmd_lnd_dst[${fl_idx}]="ncks -A -C -v ${sgs_frc} ${frc_out_sgs} ${grd_dst_sgs}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_lnd_dst[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_lnd_dst[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${grd_dst_sgs} ]; then
printf "${spt_nm}: ERROR Failed to append regridded sub-grid fraction to destination fractional grid-file. Debug this:\n${cmd_lnd_dst[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Derive mask and area in fractional destination grid-file...\n"
fi # !vrb_lvl
# 1. Set 0 sub-grid fraction to 0 imask
# 2. Compute active grid area
cmd_wheredst[${fl_idx}]="ncap2 -O -s 'where(${sgs_frc} == 0.0f) grid_imask=0; elsewhere grid_imask=1;grid_area*=${sgs_frc}' ${grd_dst_sgs} ${grd_dst_sgs}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_wheredst[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_wheredst[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${grd_dst_sgs} ]; then
printf "${spt_nm}: ERROR Failed to derive mask and area in fractional destination grid-file. Debug this:\n${cmd_wheredst[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
# Ensure map-generation uses modified grid files
grd_src=${grd_src_sgs}
grd_dst=${grd_dst_sgs}
fi # !sgs
# If user provides source gridfile, or it was inferred in sub_grid mode, assume it applies to every input file
# Do not infer source gridfiles from input files within file loop
# Generate map-file once outside of file loop, and re-use it for every input file
if [ "${grd_src_usr_flg}" = 'Yes' ] || [ "${prc_typ}" = 'sgs' ]; then
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Source grid supplied by user as ${grd_src}\n"
fi # !vrb_lvl
fl_idx=0
if [ "${wgt_typ}" = 'esmf' ]; then
rgn_opt=''
if [ -n "${hnt_src}" ]; then
rgn_opt="${rgn_opt} ${hnt_src}"
elif [ -f "${hnt_src_fl}" ]; then
rgn_opt="${rgn_opt} `cat ${hnt_src_fl}`"
fi # !hnt_src_fl
if [ -n "${hnt_dst}" ]; then
rgn_opt="${rgn_opt} ${hnt_dst}"
elif [ -f "${hnt_dst_fl}" ]; then
rgn_opt="${rgn_opt} `cat ${hnt_dst_fl}`"
fi # !hnt_dst_fl
cmd_map[${fl_idx}]="${wgt_cmd} -s ${grd_src} -d ${grd_dst} -w ${map_fl} --method ${alg_opt} ${wgt_opt} ${rgn_opt} > /dev/null"
fi # !esmf
if [ "${wgt_typ}" = 'tempest' ]; then
cmd_msh[${fl_idx}]="GenerateOverlapMesh --a ${grd_src} --b ${grd_dst} --out ${msh_fl} > /dev/null"
cmd_map[${fl_idx}]="${wgt_cmd} --in_mesh ${grd_src} --out_mesh ${grd_dst} --ov_mesh ${msh_fl} --out_map ${map_fl} ${wgt_opt} > /dev/null"
if [ "${trn_map}" = 'Yes' ]; then
# NB: Generate mono map for opposite direction regridding (i.e., reverse switches and grids), then transpose
cmd_msh[${fl_idx}]="GenerateOverlapMesh --a ${grd_dst} --b ${grd_src} --out ${msh_fl} > /dev/null"
cmd_map[${fl_idx}]="${wgt_cmd} --in_mesh ${grd_dst} --out_mesh ${grd_src} --ov_mesh ${msh_fl} --out_map ${map_trn_fl} ${wgt_opt} > /dev/null"
cmd_trn[${fl_idx}]="GenerateTransposeMap --in ${map_trn_fl} --out ${map_fl} > /dev/null"
fi # !trn_map
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_msh[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_msh[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${msh_fl} ]; then
printf "${spt_nm}: ERROR Failed to generate mesh-file. Debug this:\n${cmd_msh[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !tempest
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_map[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_map[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${map_rsl_fl} ]; then
printf "${spt_nm}: ERROR Failed to generate map-file. Debug this:\n${cmd_map[${fl_idx}]}\n"
if [ "${wgt_typ}" = 'esmf' ]; then
printf "${spt_nm}: HINT When ESMF fails to generate map-files, it often puts additional debugging information in the file named PET0.RegridWeightGen.Log in the invocation directory (${drc_pwd})\n"
fi # !esmf
exit 1
fi # !err
if [ "${map_usr_flg}" = 'Yes' ]; then
hst_att="`date`: ${cmd_ln};${cmd_map[${fl_idx}]}"
if [ "${wgt_typ}" = 'tempest' ]; then
hst_att="${hst_att};${cmd_msh[${fl_idx}]}"
fi # !tempest
cmd_att[${fl_idx}]="ncatted -O ${gaa_sng} --gaa history='${hst_att}' ${map_rsl_fl}"
eval ${cmd_att[${fl_idx}]}
if [ $? -ne 0 ]; then
printf "${spt_nm}: ERROR Failed to annotate map-file. Debug this:\n${cmd_att[${fl_idx}]}\n"
exit 1
fi # !err
fi # !map_usr_flg
fi # !dbg
if [ "${trn_map}" = 'Yes' ]; then
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_trn[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_trn[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${map_fl} ]; then
printf "${spt_nm}: ERROR Failed to transpose map-file. Debug this:\n${cmd_trn[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !trn_map
# Set map_mk to something besides 'Yes' to avoid re-generating map within file loop
map_mk='Already made map once. Never again.'
fi # !grd_src_usr_flg
# Begin loop over input files
idx_srt=0
let idx_end=$((job_nbr-1))
for ((fl_idx=0;fl_idx<${fl_nbr};fl_idx++)); do
in_fl=${fl_in[${fl_idx}]}
if [ "$(basename ${in_fl})" = "${in_fl}" ]; then
in_fl="${drc_pwd}/${in_fl}"
fi # !basename
idx_prn=`printf "%02d" ${fl_idx}`
if [ ${vrb_lvl} -ge ${vrb_1} ]; then
printf "Input #${idx_prn}: ${in_fl}\n"
fi # !vrb_lvl
if [ "${out_usr_flg}" = 'Yes' ]; then
if [ ${fl_nbr} -ge 2 ]; then
echo "ERROR: Single output filename specified with -o for multiple input files"
echo "HINT: For multiple input files use -O option to specify output directory and do not use -o or second positional option. Output files will have same name as input files, but will be in different directory."
exit 1
fi # !fl_nbr
if [ -n "${drc_usr}" ]; then
out_fl="${drc_out}/${out_fl}"
fi # !drc_usr
else # !out_usr_flg
out_fl="${drc_out}/$(basename ${in_fl})"
fi # !out_fl
if [ "${in_fl}" = "${out_fl}" ]; then
echo "ERROR: Input file = Output file = ${in_fl}"
echo "HINT: To prevent inadvertent data loss, ${spt_nm} insists that Input file and Output filenames differ"
exit 1
fi # !basename
fl_out[${fl_idx}]=${out_fl}
# Generate new map unless map-file was supplied or already-generated
# NB: Sub-grid infers (if necessary) source grid outside file loop, and forbids multiple source grids
# Sub-grid also produces map before file loop, and will not make maps inside file loop
if [ "${map_mk}" = 'Yes' ]; then
# Block 1: Special cases
if [ "${prc_typ}" = 'hirdls' ] || [ "${prc_typ}" = 'mls' ]; then
# Pre-process zonal input files so grid inferral works
# 20160214: fix record variable to work around ncpdq problem
cmd_znl[${fl_idx}]="ncecat -u lon ${nco_opt} ${nco_var_lst} ${in_fl} ${in_fl} ${in_fl} ${in_fl} ${znl_fl/znl/znl1};ncap2 ${nco_opt} -s 'lon[\$lon]={0.0,90.0,180.0,270.0}' ${znl_fl/znl/znl1} ${znl_fl/znl/znl2}"
in_fl="${znl_fl/znl/znl2}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_znl[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_znl[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f "${znl_fl/znl/znl2}" ]; then
printf "${spt_nm}: ERROR Failed to generate lat-lon file from zonal file. Debug this:\n${cmd_znl[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !znl
# Block 2: Source grid
# Block 2 Loop 1: Source gridfile command
if [ ! -f "${in_fl}" ]; then
echo "${spt_nm}: ERROR Unable to find input file ${in_fl}"
echo "HINT: All files implied to exist must be in the directory specified by their filename or in ${drc_in} before ${spt_nm} will proceed"
exit 1
fi # ! -f
# Infer source grid-file from input data file
cmd_src[${fl_idx}]="ncks ${nco_opt} --rgr infer --rgr hnt_src=${hnt_src_fl} ${nco_msk_src} ${nco_ugrid_fl} ${nco_var_rgr} --rgr scrip=${grd_src} ${in_fl} ${tmp_out_fl}"
# Block 2 Loop 2: Execute and/or echo commands
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_src[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_src[${fl_idx}]}
if [ $? -ne 0 ]; then
printf "${spt_nm}: ERROR Failed to infer source grid. Debug this:\n${cmd_src[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
# Block 3: Source->destination maps
# Block 3 Loop 1: Map-file commands
if [ ${vrb_lvl} -ge ${vrb_1} ]; then
printf "Grid(src): ${grd_src}\n"
printf "Grid(dst): ${grd_dst}\n"
fi # !vrb_lvl
if [ "${wgt_typ}" = 'esmf' ]; then
rgn_opt=''
if [ -n "${hnt_src}" ]; then
rgn_opt="${rgn_opt} ${hnt_src}"
elif [ -f "${hnt_src_fl}" ]; then
rgn_opt="${rgn_opt} `cat ${hnt_src_fl}`"
fi # !hnt_src_fl
if [ -n "${hnt_dst}" ]; then
rgn_opt="${rgn_opt} ${hnt_dst}"
elif [ -f "${hnt_dst_fl}" ]; then
rgn_opt="${rgn_opt} `cat ${hnt_dst_fl}`"
fi # !hnt_dst_fl
cmd_map[${fl_idx}]="${wgt_cmd} -s ${grd_src} -d ${grd_dst} -w ${map_fl} --method ${alg_opt} ${wgt_opt} ${rgn_opt} > /dev/null"
fi # !esmf
if [ "${wgt_typ}" = 'tempest' ]; then
printf "Mesh-File: ${msh_fl}\n"
cmd_msh[${fl_idx}]="GenerateOverlapMesh --a ${grd_src} --b ${grd_dst} --out ${msh_fl} > /dev/null"
cmd_map[${fl_idx}]="${wgt_cmd} --in_mesh ${grd_src} --out_mesh ${grd_dst} --ov_mesh ${msh_fl} --out_map ${map_fl} ${wgt_opt} > /dev/null"
if [ "${trn_map}" = 'Yes' ]; then
# NB: Generate mono map for opposite direction regridding (i.e., reverse switches and grids), then transpose
cmd_msh[${fl_idx}]="GenerateOverlapMesh --a ${grd_dst} --b ${grd_src} --out ${msh_fl} > /dev/null"
cmd_map[${fl_idx}]="${wgt_cmd} --in_mesh ${grd_dst} --out_mesh ${grd_src} --ov_mesh ${msh_fl} --out_map ${map_trn_fl} ${wgt_opt} > /dev/null"
cmd_trn[${fl_idx}]="GenerateTransposeMap --in ${map_trn_fl} --out ${map_fl} > /dev/null"
fi # !trn_map
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_msh[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_msh[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${msh_fl} ]; then
printf "${spt_nm}: ERROR Failed to generate mesh-file. Debug this:\n${cmd_msh[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !tempest
# Block 3 Loop 2: Execute and/or echo commands
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_map[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_map[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${map_rsl_fl} ]; then
printf "${spt_nm}: ERROR Failed to generate map-file. Debug this:\n${cmd_map[${fl_idx}]}\n"
if [ "${wgt_typ}" = 'esmf' ]; then
printf "${spt_nm}: HINT When ESMF fails to generate map-files, it often puts additional debugging information in the file named PET0.RegridWeightGen.Log in the invocation directory (${drc_pwd})\n"
fi # !esmf
exit 1
fi # !err
if [ "${map_usr_flg}" = 'Yes' ]; then
hst_att="`date`: ${cmd_ln};${cmd_map[${fl_idx}]}"
cmd_att[${fl_idx}]="ncatted -O ${gaa_sng} --gaa history='${hst_att}' ${map_rsl_fl}"
eval ${cmd_att[${fl_idx}]}
if [ $? -ne 0 ]; then
printf "${spt_nm}: ERROR Failed to annotate map-file. Debug this:\n${cmd_att[${fl_idx}]}\n"
exit 1
fi # !err
fi # !map_usr_flg
fi # !dbg
if [ "${trn_map}" = 'Yes' ]; then
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_trn[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_trn[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${map_fl} ]; then
printf "${spt_nm}: ERROR Failed to transpose map-file. Debug this:\n${cmd_trn[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !trn_map
# Prevent creating new source gridfile and map-file after first iteration
if [ "${mlt_map_flg}" = 'No' ] && [ ${fl_idx} -eq 0 ]; then
map_mk='Already made map once. Never again.'
fi # !mlt_map_flg
fi # !map_mk
# Block 4: Special cases
# Block 4a: Add missing metadata to MPAS files unless script was invoked by ncclimo (it makes no sense to give naked files to ncclimo and then annotate here, so assume ncclimo is working with annotated files)
if [ "${prc_typ}" = 'mpas' ] && [ "${clm_flg}" = 'No' ]; then
cmd_att[${fl_idx}]="ncatted -O -t -a _FillValue,,o,d,${mss_val} ${in_fl} ${att_fl};"
if [ ${vrb_lvl} -ge ${vrb_2} ]; then
printf "att(in) : ${in_fl}\n"
printf "att(out) : ${att_fl}\n"
fi # !vrb_lvl
in_fl="${att_fl}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_att[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_att[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f "${att_fl}" ]; then
printf "${spt_nm}: ERROR Failed to annotate MPAS file with _FillValue. Debug this:\n${cmd_att[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !mpas
# Block 4b: Generic Permutation/Unpacking (AIRS, HIRDLS, MLS, MOD04, MPAS)
if [ -n "${pdq_opt}" ]; then
if [ ${vrb_lvl} -ge ${vrb_2} ]; then
printf "PDQ(in) : ${in_fl}\n"
printf "PDQ(out) : ${pdq_fl}\n"
fi # !vrb_lvl
cmd_pdq[${fl_idx}]="ncpdq ${nco_opt} ${nco_var_lst} ${pdq_opt} ${in_fl} ${pdq_fl}"
in_fl=${pdq_fl}
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_pdq[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_pdq[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${pdq_fl} ]; then
printf "${spt_nm}: ERROR Failed to generate pdq-file. Debug this:\n${cmd_pdq[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !pdq_opt
# Block 5: Regrid
if [ ${vrb_lvl} -ge ${vrb_1} ]; then
printf "Map/Wgt : ${map_fl}\n"
printf "Regridded: ${out_fl}\n"
fi # !vrb_lvl
cmd_rgr[${fl_idx}]="${cmd_mpi[${fl_idx}]} ncks -t ${thr_nbr} ${nco_opt} ${nco_var_rgr} ${nco_var_lst} ${nco_msk_out} ${rgr_opt} --map=${map_fl} ${in_fl} ${out_fl}"
# Block 5 Loop 2: Execute and/or echo commands
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_rgr[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
if [ -z "${par_opt}" ]; then
eval ${cmd_rgr[${fl_idx}]}
if [ $? -ne 0 ]; then
printf "${spt_nm}: ERROR Failed to regrid. cmd_rgr[${fl_idx}] failed. Debug this:\n${cmd_rgr[${fl_idx}]}\n"
exit 1
fi # !err
else # !par_typ
eval ${cmd_rgr[${fl_idx}]} ${par_opt}
rgr_pid[${fl_idx}]=$!
fi # !par_typ
fi # !dbg
# Block 6: Wait
# Parallel regridding (both Background and MPI) spawns simultaneous processes in batches of ${job_nbr}
# Once ${job_nbr} jobs are running, wait() for all to finish before issuing another batch
if [ -n "${par_opt}" ]; then
let bch_idx=$((fl_idx / job_nbr))
let bch_flg=$(((fl_idx+1) % job_nbr))
#printf "${spt_nm}: fl_idx = ${fl_idx}, bch_idx = ${bch_idx}, bch_flg = ${bch_flg}\n"
if [ ${bch_flg} -eq 0 ]; then
if [ ${dbg_lvl} -ge 1 ] && [ ${idx_srt} -le ${idx_end} ]; then
printf "${spt_nm}: Waiting for batch ${bch_idx} to finish at fl_idx = ${fl_idx}...\n"
fi # !dbg
for ((pid_idx=${idx_srt};pid_idx<=${idx_end};pid_idx++)); do
wait ${rgr_pid[${pid_idx}]}
if [ $? -ne 0 ]; then
printf "${spt_nm}: ERROR Failed to regrid. cmd_rgr[${pid_idx}] failed. Debug this:\n${cmd_rgr[${pid_idx}]}\n"
exit 1
fi # !err
done # !pid_idx
let idx_srt=$((idx_srt + job_nbr))
let idx_end=$((idx_end + job_nbr))
fi # !bch_flg
fi # !par_typ
# Block 7: Special case post-processing
if [ "${prc_typ}" = 'hirdls' ] || [ "${prc_typ}" = 'mls' ]; then
# NB: Move file to avert problem with --no_tmp_fl causing self-overwrite
cmd_znl[${fl_idx}]="/bin/mv ${out_fl} ${ncwa_fl};ncwa -a lon ${nco_opt} ${nco_var_lst} ${ncwa_fl} ${out_fl}"
# Block 7 Loop 2: Execute and/or echo commands
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_znl[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_znl[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f "${out_fl}" ]; then
printf "${spt_nm}: ERROR Failed to generate zonal file from lat-lon file. Debug this:\n${cmd_znl[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !znl
done # !fl_idx
# Parallel mode might exit loop after a partial batch, wait() for remaining jobs to finish
if [ -n "${par_opt}" ]; then
let bch_flg=$((fl_nbr % job_nbr))
if [ ${bch_flg} -ne 0 ]; then
let bch_idx=$((bch_idx+1))
if [ ${dbg_lvl} -ge 1 ] && [ ${idx_srt} -lt ${fl_nbr} ]; then
printf "${spt_nm}: Waiting for (partial) batch ${bch_idx} to finish...\n"
fi # !idx_srt
for ((pid_idx=${idx_srt};pid_idx<${fl_nbr};pid_idx++)); do
wait ${rgr_pid[${pid_idx}]}
if [ $? -ne 0 ]; then
printf "${spt_nm}: ERROR Failed to regrid. cmd_rgr[${pid_idx}] failed. Debug this:\n${cmd_rgr[${pid_idx}]}\n"
exit 1
fi # !err
done # !pid_idx
fi # !bch_flg
fi # !par_typ
# fxm: Parallelize post-processing, if any
if [ "${prc_typ}" = 'sgs' ]; then
for ((fl_idx=0;fl_idx<${fl_nbr};fl_idx++)); do
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Append full gridcell area, regridded sub-grid fraction, and re-derived sub-grid mask to regridded file...\n"
fi # !vrb_lvl
# These replace user-areas area, user-areas sub-grid fraction, and naïvely regridded (rather than accurately re-derived) sub-grid mask, respectively
cmd_grd_rpl[${fl_idx}]="ncks -A -C -v area,${sgs_frc},${sgs_msk} ${frc_out_sgs} ${fl_out[${fl_idx}]}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_grd_rpl[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_grd_rpl[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${fl_out[${fl_idx}]} ]; then
printf "${spt_nm}: ERROR Failed to replace area, ${sgs_frc}, and ${sgs_msk} with full gridcell area, regridded sub-grid fraction, and re-derived sub-grid mask in output data file. Debug this:\n${cmd_grd_rpl[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
if [ -n "${prc_alm}" ]; then
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Implement idiosyncratic ALM characteristics in regridded file...\n"
fi # !vrb_lvl
# Convert area from [sr] to [km2]
cmd_alm[${fl_idx}]="ncap2 -O -s 'area*=${rds_rth}^2/1.0e6;area@long_name=\"Gridcell area\";area@units=\"km^2\"' ${fl_out[${fl_idx}]} ${fl_out[${fl_idx}]}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_alm[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_alm[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${fl_out[${fl_idx}]} ]; then
printf "${spt_nm}: ERROR Failed to replace convert output area from [sr] to [km2]. Debug this:\n${cmd_alm[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !prc_alm
if [ -n "${prc_cice}" ]; then
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "SGS: Implement idiosyncratic CICE characteristics in regridded file...\n"
fi # !vrb_lvl
# Convert area from [sr] to [m2], and aice from [frc] to [%]
cmd_cice[${fl_idx}]="ncap2 -O -s 'area*=${rds_rth}^2;area@long_name=\"Gridcell area\";area@units=\"m^2\";${sgs_frc}*=100;${sgs_frc}@units=\"%\"' ${fl_out[${fl_idx}]} ${fl_out[${fl_idx}]}"
if [ ${dbg_lvl} -ge 1 ]; then
echo ${cmd_cice[${fl_idx}]}
fi # !dbg
if [ ${dbg_lvl} -ne 2 ]; then
eval ${cmd_cice[${fl_idx}]}
if [ $? -ne 0 ] || [ ! -f ${fl_out[${fl_idx}]} ]; then
printf "${spt_nm}: ERROR Failed to replace convert output area from [sr] to [m2] and ${sgs_frc} from [frc] to [%]. Debug this:\n${cmd_cice[${fl_idx}]}\n"
exit 1
fi # !err
fi # !dbg
fi # !prc_cice
done # !fl_idx
fi # !sgs
if [ "${cln_flg}" = 'Yes' ]; then
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Clean-up intermediate files...\n"
fi # !vrb_lvl
/bin/rm -f ${att_fl} ${frc_in_sgs} ${frc_out_sgs} ${grd_dst_sgs} ${grd_dst_dfl} ${grd_src_sgs} ${grd_src_dfl} ${hnt_dst_fl} ${hnt_src_fl} ${map_fl_dfl} ${map_trn_fl} ${msh_fl_dfl} ${ncwa_fl} ${pdq_fl} ${tmp_out_fl} ${znl_fl/znl/znl1} ${znl_fl/znl/znl2}
else # !cln_flg
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
printf "Explicitly instructed not to clean-up intermediate files.\n"
fi # !vrb_lvl
fi # !cln_flg
date_end=$(date +"%s")
if [ ${vrb_lvl} -ge ${vrb_3} ]; then
if [ ${fl_nbr} -eq 0 ]; then
printf "Completed generating map-file(s) at `date`.\n"
else # !fl_nbr
echo "Quick plots of results from last regridded file:"
echo "ncview ${out_fl} &"
echo "panoply ${out_fl} &"
fi # !fl_nbr
date_dff=$((date_end-date_srt))
echo "Elapsed time $((date_dff/60))m$((date_dff % 60))s"
fi # !vrb_lvl
exit 0
|