canvod.store API Reference¶
Versioned data storage using Icechunk.
Package¶
canvod-store: Icechunk storage for GNSS VOD data.
This package provides versioned storage for GNSS VOD data using Icechunk. Manages both RINEX observation storage and VOD analysis results.
MyIcechunkStore
¶
Core Icechunk store manager for GNSS data.
This class encapsulates all operations on a single Icechunk repository, providing a clean interface for GNSS data storage and retrieval with integrated logging and proper resource management.
Features: - Automatic repository creation/connection - Group management with validation - Session management with context managers - Integrated logging with file contexts - Configurable compression and chunking
Note on "metadata"¶
This class manages two distinct things both historically called "metadata":
-
File registry (
{group}/metadata/table): per-file ingest ledger tracking hashes, temporal ranges, filenames, and paths. Managed byappend_metadata(),load_metadata(),backup_metadata_table(), etc. -
Store metadata (
canvod.store_metadatapackage): store-level provenance (identity, creator, environment, compliance). Written to Zarr root attrs by the orchestrator. Seecanvod-store-metadata.
Parameters¶
store_path : Path Path to the Icechunk store directory. store_type : str, default "rinex_store" Type of store ("rinex_store" or "vod_store"). compression_level : int | None, optional Override default compression level. compression_algorithm : str | None, optional Override default compression algorithm.
Attributes¶
store_path : Path Path to the Icechunk store directory. store_type : str Type of store ("rinex_store" or "vod_store"). compression_level : int Compression level (1-9). compression_algorithm : icechunk.CompressionAlgorithm Compression algorithm enum. repo : icechunk.Repository The Icechunk repository instance.
Source code in packages/canvod-store/src/canvod/store/store.py
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 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 | |
repo
property
¶
Get the repository instance.
source_format
property
¶
Return the source_format root attribute, or None.
tree
property
¶
Display hierarchical tree of all branches, groups, and subgroups.
__init__(store_path, store_type='rinex_store', compression_level=None, compression_algorithm=None)
¶
Initialize the Icechunk store manager.
Parameters¶
store_path : Path Path to the Icechunk store directory. store_type : str, default "rinex_store" Type of store ("rinex_store" or "vod_store"). compression_level : int | None, optional Override default compression level. compression_algorithm : str | None, optional Override default compression algorithm.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
readonly_session(branch='main')
¶
Context manager for readonly sessions.
Parameters¶
branch : str, default "main" Branch name.
Returns¶
Generator[icechunk.ReadonlySession, None, None] Readonly session context manager.
Source code in packages/canvod-store/src/canvod/store/store.py
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
writable_session(branch='main')
¶
Context manager for writable sessions.
Parameters¶
branch : str, default "main" Branch name.
Returns¶
Generator[icechunk.WritableSession, None, None] Writable session context manager.
Source code in packages/canvod-store/src/canvod/store/store.py
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | |
set_root_attrs(attrs, branch='main')
¶
Set root-level Zarr attributes on the store.
Parameters¶
attrs : dict[str, Any] Key-value pairs to merge into root attrs. branch : str, default "main" Branch to write to.
Returns¶
str Snapshot ID from the commit.
Source code in packages/canvod-store/src/canvod/store/store.py
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | |
get_root_attrs(branch='main')
¶
Read root-level Zarr attributes from the store.
Returns¶
dict[str, Any] Root attributes (empty dict if none set).
Source code in packages/canvod-store/src/canvod/store/store.py
281 282 283 284 285 286 287 288 289 290 291 292 293 294 | |
get_branch_names()
¶
List all branches in the store.
Returns¶
list[str] List of branch names.
Source code in packages/canvod-store/src/canvod/store/store.py
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 | |
get_group_names(branch=None)
¶
List all groups in the store.
Parameters¶
branch: Optional[str] Repository branch to examine. Defaults to listing groups from all branches.
Returns¶
dict[str, list[str]] Dictionary mapping branch names to lists of group names.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
list_groups(branch='main')
¶
List all groups in a branch.
Parameters¶
branch : str Branch name (default: "main")
Returns¶
list[str] List of group names in the branch
Source code in packages/canvod-store/src/canvod/store/store.py
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | |
print_tree(max_depth=None)
¶
Display hierarchical tree of all branches, groups, and subgroups.
Parameters¶
max_depth : int | None Maximum depth to display. None for unlimited depth. - 0: Only show branches - 1: Show branches and top-level groups - 2: Show branches, groups, and first level of subgroups/arrays - etc.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
group_exists(group_name, branch='main')
¶
Check if a group exists.
Parameters¶
group_name : str Name of the group to check. branch : str, default "main" Repository branch to examine.
Returns¶
bool True if the group exists, False otherwise.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
read_group(group_name, branch='main', time_slice=None, date=None, chunks=None)
¶
Read data from a group.
Parameters¶
group_name : str
Name of the group to read.
branch : str, default "main"
Repository branch.
time_slice : slice | None, optional
Optional label-based time slice for filtering (passed to ds.sel).
date : str | None, optional
YYYYDOY string (e.g. "2025001") selecting a single calendar day.
Converted to a time_slice; mutually exclusive with time_slice.
chunks : dict[str, Any] | None, optional
Chunking specification (uses config defaults if None).
Returns¶
xr.Dataset Dataset from the group.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
read_group_deduplicated(group_name, branch='main', keep='last', time_slice=None, chunks=None)
¶
Read data from a group with automatic deduplication.
This method calls read_group() then removes duplicates using metadata table intelligence when available, falling back to simple epoch deduplication.
Parameters¶
group_name : str Name of the group to read. branch : str, default "main" Repository branch. keep : str, default "last" Deduplication strategy for duplicate epochs. time_slice : slice | None, optional Optional time slice for filtering. chunks : dict[str, Any] | None, optional Chunking specification (uses config defaults if None).
Returns¶
xr.Dataset Dataset with duplicates removed (latest data only).
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
write_dataset(dataset, group_name, session, mode='a', chunks=None)
¶
Write a dataset to Icechunk with proper chunking.
Parameters¶
dataset : xr.Dataset Dataset to write group_name : str Group path in store session : Any Active writable session or store handle. mode : str Write mode: 'w' (overwrite) or 'a' (append) chunks : dict[str, int] | None Chunking spec. If None, uses store's chunk_strategy. Example: {'epoch': 34560, 'sid': -1}
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
write_initial_group(dataset, group_name, branch='main', commit_message=None)
¶
Write initial data to a new group.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
backup_metadata_table(group_name, session)
¶
Backup the metadata table to a Polars DataFrame.
Parameters¶
group_name : str Group name. session : Any Active session for reading.
Returns¶
pl.DataFrame | None DataFrame with metadata rows, or None if missing.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
restore_metadata_table(group_name, df, session)
¶
Restore the metadata table from a Polars DataFrame.
This recreates the full Zarr structure for the metadata table.
Parameters¶
group_name : str Group name. df : pl.DataFrame Metadata table to restore. session : Any Active session for writing.
Returns¶
None
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
overwrite_file_in_group(dataset, group_name, rinex_hash, start, end, branch='main', commit_message=None)
¶
Overwrite a file's contribution to the group (same hash, new epoch range).
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
get_group_info(group_name, branch='main')
¶
Get metadata about a group.
Parameters¶
group_name : str Name of the group. branch : str, default "main" Repository branch to examine.
Returns¶
dict[str, Any] Group metadata.
Raises¶
ValueError If the group does not exist.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
metadata_dataset_exists(group_name, name, branch='main')
¶
Return True if a metadata dataset name exists for group_name.
Source code in packages/canvod-store/src/canvod/store/store.py
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 | |
write_metadata_dataset(meta_ds, group_name, name, branch='main')
¶
Write a pre-concatenated metadata dataset to {group_name}/metadata/{name}.
Always writes with mode="w" (full overwrite for the day).
Parameters¶
meta_ds : xr.Dataset
Pre-concatenated (epoch, sid) metadata dataset.
group_name : str
Target group (receiver name).
name : str
Dataset name under metadata/ (e.g. "sbf_obs").
branch : str, default "main"
Repository branch to write to.
Returns¶
str Icechunk snapshot ID.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_metadata_datasets(parts, group_name, name, branch='main')
¶
Write metadata datasets incrementally — no in-memory concat.
The first dataset initialises the group (mode="w"), subsequent
datasets are appended along epoch. All writes happen inside a
single session/commit so the operation is atomic.
Parameters¶
parts : list[xr.Dataset]
Individual per-file metadata datasets with an epoch dim.
group_name : str
Target group (receiver name).
name : str
Dataset name under metadata/ (e.g. "sbf_obs").
branch : str, default "main"
Repository branch to write to.
Returns¶
str Icechunk snapshot ID.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
read_metadata_dataset(group_name, name, branch='main', chunks=None)
¶
Read a metadata dataset name for group_name.
Parameters¶
group_name : str
Group (receiver) name.
name : str
Dataset name under metadata/ (e.g. "sbf_obs").
branch : str, default "main"
Repository branch.
chunks : dict | None, optional
Dask chunk specification. Defaults to
{"epoch": 34560, "sid": -1}.
Returns¶
xr.Dataset
Lazy (epoch, sid) metadata dataset.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
get_metadata_dataset_info(group_name, name, branch='main')
¶
Get info about metadata dataset name for group_name.
Parameters¶
group_name : str
Group (receiver) name.
name : str
Dataset name under metadata/ (e.g. "sbf_obs").
branch : str, default "main"
Repository branch.
Returns¶
dict[str, Any]
Info dict with the same structure as get_group_info().
Raises¶
ValueError If the metadata dataset does not exist.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
sbf_metadata_exists(group_name, branch='main')
¶
Return True if an SBF metadata dataset exists for group_name.
Source code in packages/canvod-store/src/canvod/store/store.py
1211 1212 1213 | |
write_sbf_metadata(meta_ds, group_name, branch='main')
¶
Write SBF metadata dataset.
Source code in packages/canvod-store/src/canvod/store/store.py
1215 1216 1217 1218 1219 | |
read_sbf_metadata(group_name, branch='main', chunks=None)
¶
Read SBF metadata dataset.
Source code in packages/canvod-store/src/canvod/store/store.py
1221 1222 1223 1224 1225 | |
get_sbf_metadata_info(group_name, branch='main')
¶
Get SBF metadata info.
Source code in packages/canvod-store/src/canvod/store/store.py
1227 1228 1229 1230 1231 | |
rel_path_for_commit(file_path)
¶
Generate relative path for commit messages.
Parameters¶
file_path : Path Full file path.
Returns¶
str Relative path string with log_path_depth parts.
Source code in packages/canvod-store/src/canvod/store/store.py
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 | |
get_store_stats()
¶
Get statistics about the store.
Returns¶
dict[str, Any] Store statistics.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_to_group(dataset, group_name, append_dim='epoch', branch='main', action='write', commit_message=None)
¶
Append data to an existing group.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
write_or_append_group(dataset, group_name, append_dim='epoch', branch='main', commit_message=None, dedup=False)
¶
Write or append a dataset to a group.
By default (dedup=False) no guardrails are applied — suitable for
VOD stores and other derived-data stores where rinex-style dedup does
not apply.
When dedup=True the method runs a full hash-match + temporal-overlap
check (via :meth:should_skip_file) before opening a write session.
This makes the store the authoritative final gate for RINEX/SBF ingest
paths, backstopping any pre-checks in the caller.
If the group does not exist, creates it (mode='w').
If it exists, appends along append_dim.
Parameters¶
dataset : xr.Dataset
Dataset to write or append.
group_name : str
Target Icechunk group.
append_dim : str, default "epoch"
Dimension along which to append when the group already exists.
branch : str, default "main"
Icechunk branch to write to.
commit_message : str or None
Commit message. Auto-generated if None.
dedup : bool, default False
When True, check for duplicate hash or temporal overlap before
writing. If the dataset would be a duplicate, the write is skipped,
a warning is logged, and False is returned. Set to True for
RINEX/SBF ingest; leave False for VOD and derived-data stores.
Returns¶
bool
True if the dataset was written, False if skipped
(only possible when dedup=True).
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_metadata(group_name, rinex_hash, start, end, snapshot_id, action, commit_msg, dataset_attrs, branch='main', canonical_name=None, physical_path=None)
¶
Append a metadata row into the group_name/metadata/table.
Schema
index int64 (continuous row id) rinex_hash str (UTF-8, VariableLengthUTF8) start datetime64[ns] end datetime64[ns] snapshot_id str (UTF-8) action str (UTF-8, e.g. "insert"|"append"|"overwrite"|"skip") commit_msg str (UTF-8) written_at str (UTF-8, ISO8601 with timezone) write_strategy str (UTF-8, RINEX_STORE_STRATEGY or VOD_STORE_STRATEGY) attrs str (UTF-8, JSON dump of dataset attrs)
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_metadata_bulk(group_name, rows, session=None)
¶
Append multiple metadata rows in one commit.
Parameters¶
group_name : str Group name (e.g. "canopy", "reference") rows : list[dict[str, Any]] List of metadata records matching the schema used in append_metadata(). session : icechunk.WritableSession, optional If provided, rows are written into this session (caller commits later). If None, this method opens its own writable session and commits once.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
load_metadata(store, group_name)
¶
Load metadata directly from Zarr into a Polars DataFrame.
Parameters¶
store : Any Zarr store or session store handle. group_name : str Group name.
Returns¶
pl.DataFrame Metadata table.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
read_metadata_table(session, group_name)
¶
Read the metadata table from a session.
Parameters¶
session : Any Active session for reading. group_name : str Group name.
Returns¶
pl.DataFrame Metadata table.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
metadata_row_exists(group_name, rinex_hash, start, end, branch='main')
¶
Check whether a file already exists or temporally overlaps existing data.
Performs two checks in order:
- Hash match — if
rinex_hashalready appears in the metadata table, the file was previously ingested (exact duplicate). - Temporal overlap — if the incoming
[start, end]interval overlaps any existing metadata interval, the file covers a time range that is already (partially) present in the store. This catches cases like a daily concatenation file coexisting with the sub-daily files it was built from.
Parameters¶
group_name : str Icechunk group name. rinex_hash : str Hash of the current GNSS dataset. start : np.datetime64 Start epoch of the incoming file. end : np.datetime64 End epoch of the incoming file. branch : str, default "main" Branch name in the Icechunk repository.
Returns¶
tuple[bool, pl.DataFrame]
(True, overlapping_rows) when the file should be skipped,
(False, empty_df) when it is safe to ingest.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
should_skip_file(group_name, file_hash, time_start, time_end, branch='main')
¶
Check whether a file should be skipped before processing and writing.
Thin public wrapper around :meth:metadata_row_exists that returns a
simple (skip, reason) pair instead of a DataFrame, suitable for use
in Airflow task functions as an early-exit optimisation.
This method is an early-exit optimisation: it avoids opening a write
session for files that are already present. Pass dedup=True to
:meth:write_or_append_group to make the store the authoritative
final gate (runs the same check again before writing).
Checks performed (in order):
- Hash match — file was previously ingested (exact duplicate).
- Temporal overlap — incoming time range overlaps existing epochs.
Layer 3 (intra-batch overlap) is not applicable here because task functions process files one at a time.
Parameters¶
group_name : str
Icechunk group name.
file_hash : str or None
Hash from dataset.attrs["File Hash"]. When None the check
is skipped and (False, "") is returned.
time_start : np.datetime64
First epoch of the incoming dataset.
time_end : np.datetime64
Last epoch of the incoming dataset.
branch : str, default "main"
Branch name in the Icechunk repository.
Returns¶
tuple[bool, str]
(True, "hash_match") — exact duplicate, skip.
(True, "temporal_overlap") — overlapping time range, skip.
(False, "") — safe to ingest.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
batch_check_existing(group_name, file_hashes)
¶
Check which file hashes already exist in metadata.
Source code in packages/canvod-store/src/canvod/store/store.py
1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 | |
check_temporal_overlaps(group_name, file_intervals, branch='main')
¶
Check which files temporally overlap existing metadata intervals.
Parameters¶
group_name : str
Icechunk group name.
file_intervals : list[tuple[str, np.datetime64, np.datetime64]]
List of (rinex_hash, start, end) tuples for incoming files.
branch : str, default "main"
Branch name in the Icechunk repository.
Returns¶
set[str]
Hashes of files whose [start, end] overlaps any existing
metadata interval. Files whose hash already exists in the store
are NOT included (use batch_check_existing for those).
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_metadata_bulk_store(group_name, rows, store)
¶
Append metadata rows into an open transaction store.
Parameters¶
group_name : str Group name (e.g. "canopy", "reference"). rows : list[dict[str, Any]] Metadata rows to append. store : Any Open Icechunk transaction store.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
expire_old_snapshots(days=None, branch='main', delete_expired_branches=True, delete_expired_tags=True)
¶
Expire and garbage-collect snapshots older than the given retention period.
Parameters¶
days : int | None, optional Number of days to retain snapshots. Defaults to config value. branch : str, default "main" Branch to apply expiration on. delete_expired_branches : bool, default True Whether to delete branches pointing to expired snapshots. delete_expired_tags : bool, default True Whether to delete tags pointing to expired snapshots.
Returns¶
set[str] Expired snapshot IDs.
Source code in packages/canvod-store/src/canvod/store/store.py
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 2084 2085 2086 | |
get_history(branch='main', limit=None)
¶
Return commit ancestry (history) for a branch.
Parameters¶
branch : str, default "main" Branch name. limit : int | None, optional Maximum number of commits to return.
Returns¶
list[dict] Commit info dictionaries (id, message, written_at, parent_ids).
Source code in packages/canvod-store/src/canvod/store/store.py
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 | |
print_history(branch='main', limit=100)
¶
Pretty-print the ancestry for quick inspection.
Source code in packages/canvod-store/src/canvod/store/store.py
2121 2122 2123 2124 2125 2126 2127 | |
__repr__()
¶
Return the developer-facing representation.
Returns¶
str Representation string.
Source code in packages/canvod-store/src/canvod/store/store.py
2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 | |
__str__()
¶
Return a human-readable summary.
Returns¶
str Summary string.
Source code in packages/canvod-store/src/canvod/store/store.py
2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 | |
rechunk_group(group_name, chunks, source_branch='main', temp_branch=None, promote_to_main=True, delete_temp_branch=True)
¶
Rechunk a group with optimal chunk sizes.
Parameters¶
group_name : str Name of the group to rechunk chunks : dict[str, int] Chunking specification, e.g. {'epoch': 34560, 'sid': -1} source_branch : str Branch to read original data from (default: "main") temp_branch : str | None Temporary branch name for rechunked data. If None, uses "{group_name}_rechunked". promote_to_main : bool If True, reset main branch to rechunked snapshot after writing delete_temp_branch : bool If True, delete temporary branch after promotion (only if promote_to_main=True).
Returns¶
str Snapshot ID of the rechunked data
Source code in packages/canvod-store/src/canvod/store/store.py
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 | |
rechunk_group_verbose(group_name, chunks=None, source_branch='main', temp_branch=None, promote_to_main=True, delete_temp_branch=True)
¶
Rechunk a group with optimal chunk sizes.
Parameters¶
group_name : str
Name of the group to rechunk
chunks : dict[str, int] | None
Chunking specification, e.g. {'epoch': 34560, 'sid': -1}. Defaults
to gnnsvodpy.globals.ICECHUNK_CHUNK_STRATEGIES.
source_branch : str
Branch to read original data from (default: "main")
temp_branch : str | None
Temporary branch name for rechunked data. If None, uses
"{group_name}_rechunked".
promote_to_main : bool
If True, reset main branch to rechunked snapshot after writing
delete_temp_branch : bool
If True, delete temporary branch after promotion (only if
promote_to_main=True).
Returns¶
str Snapshot ID of the rechunked data
Source code in packages/canvod-store/src/canvod/store/store.py
2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 | |
create_release_tag(tag_name, snapshot_id=None)
¶
Create an immutable tag for an important version.
Parameters¶
tag_name : str Name for the tag (e.g., "v2024_complete", "before_reprocess") snapshot_id : str | None Snapshot to tag. If None, uses current tip of main branch.
Source code in packages/canvod-store/src/canvod/store/store.py
2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 | |
list_tags()
¶
List all tags in the repository.
Source code in packages/canvod-store/src/canvod/store/store.py
2458 2459 2460 | |
delete_tag(tag_name)
¶
Delete a tag (use with caution - tags are meant to be permanent).
Source code in packages/canvod-store/src/canvod/store/store.py
2462 2463 2464 2465 | |
plot_commit_graph(max_commits=100)
¶
Visualize commit history as an interactive git-like graph.
Creates an interactive visualization showing: - Branches with different colors - Chronological commit ordering - Branch divergence points - Commit messages on hover - Click to see commit details
Parameters¶
max_commits : int Maximum number of commits to display (default: 100).
Returns¶
Figure Interactive plotly figure (works in marimo and Jupyter).
Source code in packages/canvod-store/src/canvod/store/store.py
2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 | |
cleanup_stale_branches(keep_patterns=None)
¶
Delete stale temporary branches (e.g., from failed rechunking).
Parameters¶
keep_patterns : list[str] | None Patterns to preserve. Default: ["main", "dev"]
Returns¶
list[str] Names of deleted branches
Source code in packages/canvod-store/src/canvod/store/store.py
2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 | |
delete_branch(branch_name)
¶
Delete a branch.
Source code in packages/canvod-store/src/canvod/store/store.py
2785 2786 2787 2788 2789 2790 2791 | |
get_snapshot_info(snapshot_id)
¶
Get detailed information about a specific snapshot.
Parameters¶
snapshot_id : str Snapshot ID to inspect
Returns¶
dict Snapshot metadata and statistics
Source code in packages/canvod-store/src/canvod/store/store.py
2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 | |
compare_snapshots(snapshot_id_1, snapshot_id_2)
¶
Compare two snapshots to see what changed.
Parameters¶
snapshot_id_1 : str First snapshot (older) snapshot_id_2 : str Second snapshot (newer)
Returns¶
dict Comparison results showing added/removed/modified groups
Source code in packages/canvod-store/src/canvod/store/store.py
2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 | |
maintenance(expire_days=7, cleanup_branches=True, run_gc=True)
¶
Run full maintenance on the store.
Parameters¶
expire_days : int Days of snapshot history to keep cleanup_branches : bool Remove stale temporary branches run_gc : bool Run garbage collection after expiration
Returns¶
dict Summary of maintenance actions
Source code in packages/canvod-store/src/canvod/store/store.py
2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 | |
sanitize_store(source_branch='main', temp_branch='sanitize_temp', promote_to_main=True, delete_temp_branch=True)
¶
Sanitize all groups by removing NaN-only SIDs and cleaning coordinates.
Creates a temporary branch, applies sanitization to all groups, then optionally promotes to main and cleans up.
Parameters¶
source_branch : str, default "main" Branch to read original data from. temp_branch : str, default "sanitize_temp" Temporary branch name for sanitized data. promote_to_main : bool, default True If True, reset main branch to sanitized snapshot after writing. delete_temp_branch : bool, default True If True, delete temporary branch after promotion.
Returns¶
str Snapshot ID of the sanitized data.
Source code in packages/canvod-store/src/canvod/store/store.py
2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 | |
safe_temporal_aggregate(group, freq='1D', vars_to_aggregate=('VOD',), geometry_vars=('phi', 'theta'), drop_empty=True, branch='main')
¶
Aggregate temporally irregular VOD data per SID.
Each satellite (SID) is aggregated independently within each time bin. Mixing observations across satellites is physically meaningless because each observes a different part of the canopy from a different sky position.
.. note::
For production use, prefer canvod.ops.TemporalAggregate
which uses Polars groupby and handles all coordinate types
explicitly. This method is a convenience wrapper for quick
interactive exploration.
Parameters¶
group : str Group name to aggregate. freq : str, default "1D" Resample frequency string. vars_to_aggregate : Sequence[str], optional Variables to aggregate using mean. geometry_vars : Sequence[str], optional Geometry variables to aggregate using mean (centroid of contributing sky positions). drop_empty : bool, default True Drop empty epochs after aggregation. branch : str, default "main" Branch name to read from.
Returns¶
xr.Dataset Aggregated dataset with independent per-SID aggregation.
Source code in packages/canvod-store/src/canvod/store/store.py
3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 | |
safe_temporal_aggregate_to_branch(source_group, target_group, target_branch, freq='1D', overwrite=False, **kwargs)
¶
Aggregate a group and save to a new Icechunk branch/group.
Parameters¶
source_group : str Source group name. target_group : str Target group name. target_branch : str Target branch name. freq : str, default "1D" Resample frequency string. overwrite : bool, default False Whether to overwrite an existing branch. **kwargs : Any Additional keyword args passed to safe_temporal_aggregate().
Returns¶
xr.Dataset Aggregated dataset written to the target branch.
Source code in packages/canvod-store/src/canvod/store/store.py
3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 | |
GnssResearchSite
¶
High-level manager for a GNSS research site with dual Icechunk stores.
This class coordinates between RINEX data storage (Level 1) and VOD analysis storage (Level 2), providing a unified interface for site-wide operations.
Architecture: - RINEX Store: Raw/standardized observations per receiver - VOD Store: Analysis products comparing receiver pairs
Features: - Automatic store initialization from config - Receiver management and validation - Analysis workflow coordination - Unified logging and error handling
Parameters¶
site_name : str Name of the research site (must exist in config).
Raises¶
KeyError
If site_name is not found in the RESEARCH_SITES config.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
site_config
property
¶
Get the site configuration as a dictionary.
receivers
property
¶
Get all configured receivers for this site.
active_receivers
property
¶
Get only active receivers for this site.
vod_analyses
property
¶
Get all configured VOD analyses for this site.
Returns auto-derived analyses from scs_from if no explicit vod_analyses are configured.
active_vod_analyses
property
¶
Get only active VOD analyses for this site.
__init__(site_name)
¶
Initialize the site manager.
Parameters¶
site_name : str Name of the research site.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
get_receiver_metadata(receiver_name)
¶
Get freeform metadata for a receiver.
Returns the metadata dict from ReceiverConfig in
sites.yaml, or None if not configured.
Parameters¶
receiver_name : str Name of the receiver.
Returns¶
dict or None Receiver metadata dict, or None.
Source code in packages/canvod-store/src/canvod/store/manager.py
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | |
from_rinex_store_path(rinex_store_path)
classmethod
¶
Create a GnssResearchSite instance from a RINEX store path.
Parameters¶
rinex_store_path : Path Path to the RINEX Icechunk store.
Returns¶
GnssResearchSite Initialized research site manager.
Raises¶
ValueError If no matching site is found for the given path.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
get_reference_canopy_pairs()
¶
Expand scs_from into (reference_name, canopy_name) pairs.
Returns¶
list[tuple[str, str]] List of (reference_name, canopy_name) pairs.
Source code in packages/canvod-store/src/canvod/store/manager.py
199 200 201 202 203 204 205 206 207 | |
get_auto_vod_analyses()
¶
Derive VOD analysis pairs from scs_from configuration.
Creates one VOD pair per (canopy, reference_for_that_canopy) combination.
Returns¶
dict[str, VodAnalysisConfig] Auto-derived VOD analyses keyed by analysis name.
Source code in packages/canvod-store/src/canvod/store/manager.py
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 | |
validate_site_config()
¶
Validate that the site configuration is consistent.
Returns¶
bool True if configuration is valid.
Raises¶
ValueError If configuration is invalid.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
get_receiver_groups()
¶
Get list of receiver groups that exist in the RINEX store.
Returns¶
list[str] Existing receiver group names.
Source code in packages/canvod-store/src/canvod/store/manager.py
283 284 285 286 287 288 289 290 291 292 | |
get_vod_analysis_groups()
¶
Get list of VOD analysis groups that exist in the VOD store.
Returns¶
list[str] Existing VOD analysis group names.
Source code in packages/canvod-store/src/canvod/store/manager.py
294 295 296 297 298 299 300 301 302 303 | |
ingest_receiver_data(dataset, receiver_name, commit_message=None)
¶
Ingest RINEX data for a specific receiver.
Parameters¶
dataset : xr.Dataset Processed RINEX dataset to store. receiver_name : str Name of the receiver (must be configured). commit_message : str, optional Commit message to store with the data.
Raises¶
ValueError
If receiver_name is not configured.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
read_receiver_data(receiver_name, time_range=None)
¶
Read data from a specific receiver.
Parameters¶
receiver_name : str Name of the receiver. time_range : tuple of datetime, optional (start_time, end_time) for filtering the data.
Returns¶
xr.Dataset Dataset containing receiver observations.
Raises¶
ValueError If the receiver group does not exist.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
store_vod_analysis(vod_dataset, analysis_name, commit_message=None)
¶
Store VOD analysis results.
Parameters¶
vod_dataset : xr.Dataset Dataset containing VOD analysis results. analysis_name : str Name of the analysis (must be configured). commit_message : str, optional Commit message to store with the results.
Raises¶
ValueError
If analysis_name is not configured.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
read_vod_analysis(analysis_name, time_range=None)
¶
Read VOD analysis results.
Parameters¶
analysis_name : str Name of the analysis. time_range : tuple of datetime, optional (start_time, end_time) for filtering the results.
Returns¶
xr.Dataset Dataset containing VOD analysis results.
Raises¶
ValueError If the analysis group does not exist.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
prepare_vod_input_data(analysis_name, time_range=None)
¶
Prepare aligned input data for VOD analysis.
Reads data from both receivers specified in the analysis configuration and returns them aligned for VOD processing.
Parameters¶
analysis_name : str Name of the VOD analysis configuration. time_range : tuple of datetime, optional (start_time, end_time) for filtering the data.
Returns¶
tuple of (xr.Dataset, xr.Dataset) Tuple of (canopy_dataset, reference_dataset).
Raises¶
ValueError If the analysis is not configured or data is missing.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
calculate_vod(analysis_name, calculator_class=None, time_range=None)
¶
Calculate VOD for a configured analysis pair.
Parameters¶
analysis_name : str Analysis name from config (e.g., 'canopy_01_vs_reference_01') calculator_class : type[VODCalculator], optional VOD calculator class to use. If None, uses TauOmegaZerothOrder. time_range : tuple of datetime, optional (start_time, end_time) for filtering the data
Returns¶
xr.Dataset VOD dataset
Note¶
Requires canvod-vod to be installed.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
store_vod(vod_ds, analysis_name)
¶
Store VOD dataset in VOD store.
Parameters¶
vod_ds : xr.Dataset VOD dataset to store analysis_name : str Analysis name (group name in store)
Returns¶
str Snapshot ID
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
get_site_summary()
¶
Get a comprehensive summary of the research site.
Returns¶
dict Dictionary with site statistics, data availability, and store paths.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
is_day_complete(yyyydoy, receiver_types=None, completeness_threshold=0.95)
¶
Check if a day has complete data coverage for all receiver types.
Parameters¶
yyyydoy : str Date in YYYYDOY format (e.g., "2024256") receiver_types : List[str], optional Receiver types to check. Defaults to ['canopy', 'reference'] completeness_threshold : float Fraction of expected epochs that must exist (default 0.95 = 95%) Allows for small gaps due to receiver issues
Returns¶
bool True if all receiver types have complete data for this day
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
__repr__()
¶
Return the developer-facing representation.
Returns¶
str Representation string.
Source code in packages/canvod-store/src/canvod/store/manager.py
843 844 845 846 847 848 849 850 851 | |
__str__()
¶
Return a human-readable summary.
Returns¶
str Summary string.
Source code in packages/canvod-store/src/canvod/store/manager.py
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 | |
IcechunkDataReader
¶
Replacement for RinexFilesParser that reads from Icechunk stores.
This class provides a similar interface to the old parser but reads pre-processed data from Icechunk stores instead of processing RINEX files.
Parameters¶
matched_dirs : MatchedDirs Directory information for date/location matching site_name : str, optional Name of research site (defaults to DEFAULT_RESEARCH_SITE) n_max_workers : int, optional Maximum number of workers for parallel operations (defaults to N_MAX_THREADS) enable_gc : bool, optional Whether to enable garbage collection between operations (default True) gc_delay : float, optional Delay in seconds after garbage collection (default 1.0)
Source code in packages/canvod-store/src/canvod/store/reader.py
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 | |
__init__(matched_dirs, site_name=None, n_max_workers=None, enable_gc=True, gc_delay=1.0)
¶
Initialize the Icechunk data reader.
Parameters¶
matched_dirs : MatchedDirs
Directory information for date/location matching.
site_name : str | None, optional
Name of research site. If None, uses the first site from config.
n_max_workers : int | None, optional
Maximum number of workers for parallel operations. Defaults to config.
enable_gc : bool, optional
Whether to enable garbage collection between operations.
gc_delay : float, optional
Delay in seconds after garbage collection.
Source code in packages/canvod-store/src/canvod/store/reader.py
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 | |
__del__()
¶
Ensure the pool is shut down when the reader is deleted.
Source code in packages/canvod-store/src/canvod/store/reader.py
200 201 202 203 204 205 | |
get_receiver_by_type(receiver_type)
¶
Get list of receiver names by type.
Parameters¶
receiver_type : str Type of receiver ('canopy', 'reference')
Returns¶
list[str] List of receiver names of the specified type
Source code in packages/canvod-store/src/canvod/store/reader.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | |
parsed_rinex_data_gen_v2(keep_vars=None, receiver_types=None)
¶
Generator that processes RINEX files, augments them (φ, θ, r), and appends to Icechunk stores on-the-fly.
Yields enriched daily datasets (already augmented).
Source code in packages/canvod-store/src/canvod/store/reader.py
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 | |
parsed_rinex_data_gen(keep_vars=None, receiver_types=None)
¶
Generator that processes RINEX files and appends to Icechunk stores on-the-fly.
Parameters¶
keep_vars : list[str], optional List of variables to keep in datasets receiver_types : list[str], optional List of receiver types to process ('canopy', 'reference'). If None, defaults to ['canopy', 'reference']
Yields¶
xr.Dataset Processed and ingested datasets for each receiver type, in order
Source code in packages/canvod-store/src/canvod/store/reader.py
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 | |
get_available_receivers()
¶
Get available receivers grouped by type.
Returns¶
dict[str, list[str]] Dictionary mapping receiver types to lists of receiver names.
Source code in packages/canvod-store/src/canvod/store/reader.py
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 | |
__str__()
¶
Return a human-readable summary.
Returns¶
str Summary string.
Source code in packages/canvod-store/src/canvod/store/reader.py
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 | |
create_rinex_store(store_path)
¶
Create a RINEX Icechunk store with appropriate configuration.
Parameters¶
store_path : Path Path to the store directory.
Returns¶
MyIcechunkStore Configured store for RINEX data.
Source code in packages/canvod-store/src/canvod/store/store.py
3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 | |
create_vod_store(store_path)
¶
Create a VOD Icechunk store with appropriate configuration.
Parameters¶
store_path : Path Path to the store directory.
Returns¶
MyIcechunkStore Configured store for VOD analysis data.
Source code in packages/canvod-store/src/canvod/store/store.py
3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 | |
Store Manager¶
Research site manager that coordinates RINEX and VOD Icechunk stores.
This module provides the GnssResearchSite class that manages both stores for a research site and provides high-level operations across them.
Module: src/gnssvodpy/icechunk_manager/manager.py
GnssResearchSite
¶
High-level manager for a GNSS research site with dual Icechunk stores.
This class coordinates between RINEX data storage (Level 1) and VOD analysis storage (Level 2), providing a unified interface for site-wide operations.
Architecture: - RINEX Store: Raw/standardized observations per receiver - VOD Store: Analysis products comparing receiver pairs
Features: - Automatic store initialization from config - Receiver management and validation - Analysis workflow coordination - Unified logging and error handling
Parameters¶
site_name : str Name of the research site (must exist in config).
Raises¶
KeyError
If site_name is not found in the RESEARCH_SITES config.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
site_config
property
¶
Get the site configuration as a dictionary.
receivers
property
¶
Get all configured receivers for this site.
active_receivers
property
¶
Get only active receivers for this site.
vod_analyses
property
¶
Get all configured VOD analyses for this site.
Returns auto-derived analyses from scs_from if no explicit vod_analyses are configured.
active_vod_analyses
property
¶
Get only active VOD analyses for this site.
__init__(site_name)
¶
Initialize the site manager.
Parameters¶
site_name : str Name of the research site.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
get_receiver_metadata(receiver_name)
¶
Get freeform metadata for a receiver.
Returns the metadata dict from ReceiverConfig in
sites.yaml, or None if not configured.
Parameters¶
receiver_name : str Name of the receiver.
Returns¶
dict or None Receiver metadata dict, or None.
Source code in packages/canvod-store/src/canvod/store/manager.py
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | |
from_rinex_store_path(rinex_store_path)
classmethod
¶
Create a GnssResearchSite instance from a RINEX store path.
Parameters¶
rinex_store_path : Path Path to the RINEX Icechunk store.
Returns¶
GnssResearchSite Initialized research site manager.
Raises¶
ValueError If no matching site is found for the given path.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
get_reference_canopy_pairs()
¶
Expand scs_from into (reference_name, canopy_name) pairs.
Returns¶
list[tuple[str, str]] List of (reference_name, canopy_name) pairs.
Source code in packages/canvod-store/src/canvod/store/manager.py
199 200 201 202 203 204 205 206 207 | |
get_auto_vod_analyses()
¶
Derive VOD analysis pairs from scs_from configuration.
Creates one VOD pair per (canopy, reference_for_that_canopy) combination.
Returns¶
dict[str, VodAnalysisConfig] Auto-derived VOD analyses keyed by analysis name.
Source code in packages/canvod-store/src/canvod/store/manager.py
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 | |
validate_site_config()
¶
Validate that the site configuration is consistent.
Returns¶
bool True if configuration is valid.
Raises¶
ValueError If configuration is invalid.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
get_receiver_groups()
¶
Get list of receiver groups that exist in the RINEX store.
Returns¶
list[str] Existing receiver group names.
Source code in packages/canvod-store/src/canvod/store/manager.py
283 284 285 286 287 288 289 290 291 292 | |
get_vod_analysis_groups()
¶
Get list of VOD analysis groups that exist in the VOD store.
Returns¶
list[str] Existing VOD analysis group names.
Source code in packages/canvod-store/src/canvod/store/manager.py
294 295 296 297 298 299 300 301 302 303 | |
ingest_receiver_data(dataset, receiver_name, commit_message=None)
¶
Ingest RINEX data for a specific receiver.
Parameters¶
dataset : xr.Dataset Processed RINEX dataset to store. receiver_name : str Name of the receiver (must be configured). commit_message : str, optional Commit message to store with the data.
Raises¶
ValueError
If receiver_name is not configured.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
read_receiver_data(receiver_name, time_range=None)
¶
Read data from a specific receiver.
Parameters¶
receiver_name : str Name of the receiver. time_range : tuple of datetime, optional (start_time, end_time) for filtering the data.
Returns¶
xr.Dataset Dataset containing receiver observations.
Raises¶
ValueError If the receiver group does not exist.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
store_vod_analysis(vod_dataset, analysis_name, commit_message=None)
¶
Store VOD analysis results.
Parameters¶
vod_dataset : xr.Dataset Dataset containing VOD analysis results. analysis_name : str Name of the analysis (must be configured). commit_message : str, optional Commit message to store with the results.
Raises¶
ValueError
If analysis_name is not configured.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
read_vod_analysis(analysis_name, time_range=None)
¶
Read VOD analysis results.
Parameters¶
analysis_name : str Name of the analysis. time_range : tuple of datetime, optional (start_time, end_time) for filtering the results.
Returns¶
xr.Dataset Dataset containing VOD analysis results.
Raises¶
ValueError If the analysis group does not exist.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
prepare_vod_input_data(analysis_name, time_range=None)
¶
Prepare aligned input data for VOD analysis.
Reads data from both receivers specified in the analysis configuration and returns them aligned for VOD processing.
Parameters¶
analysis_name : str Name of the VOD analysis configuration. time_range : tuple of datetime, optional (start_time, end_time) for filtering the data.
Returns¶
tuple of (xr.Dataset, xr.Dataset) Tuple of (canopy_dataset, reference_dataset).
Raises¶
ValueError If the analysis is not configured or data is missing.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
calculate_vod(analysis_name, calculator_class=None, time_range=None)
¶
Calculate VOD for a configured analysis pair.
Parameters¶
analysis_name : str Analysis name from config (e.g., 'canopy_01_vs_reference_01') calculator_class : type[VODCalculator], optional VOD calculator class to use. If None, uses TauOmegaZerothOrder. time_range : tuple of datetime, optional (start_time, end_time) for filtering the data
Returns¶
xr.Dataset VOD dataset
Note¶
Requires canvod-vod to be installed.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
store_vod(vod_ds, analysis_name)
¶
Store VOD dataset in VOD store.
Parameters¶
vod_ds : xr.Dataset VOD dataset to store analysis_name : str Analysis name (group name in store)
Returns¶
str Snapshot ID
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
get_site_summary()
¶
Get a comprehensive summary of the research site.
Returns¶
dict Dictionary with site statistics, data availability, and store paths.
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
is_day_complete(yyyydoy, receiver_types=None, completeness_threshold=0.95)
¶
Check if a day has complete data coverage for all receiver types.
Parameters¶
yyyydoy : str Date in YYYYDOY format (e.g., "2024256") receiver_types : List[str], optional Receiver types to check. Defaults to ['canopy', 'reference'] completeness_threshold : float Fraction of expected epochs that must exist (default 0.95 = 95%) Allows for small gaps due to receiver issues
Returns¶
bool True if all receiver types have complete data for this day
Source code in packages/canvod-store/src/canvod/store/manager.py
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 | |
__repr__()
¶
Return the developer-facing representation.
Returns¶
str Representation string.
Source code in packages/canvod-store/src/canvod/store/manager.py
843 844 845 846 847 848 849 850 851 | |
__str__()
¶
Return a human-readable summary.
Returns¶
str Summary string.
Source code in packages/canvod-store/src/canvod/store/manager.py
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 | |
create_default_site()
¶
Create a GnssResearchSite instance for the default site.
Returns¶
GnssResearchSite
Instance for the DEFAULT_RESEARCH_SITE.
Source code in packages/canvod-store/src/canvod/store/manager.py
873 874 875 876 877 878 879 880 881 882 883 884 | |
Data Store¶
MyIcechunkStore
¶
Core Icechunk store manager for GNSS data.
This class encapsulates all operations on a single Icechunk repository, providing a clean interface for GNSS data storage and retrieval with integrated logging and proper resource management.
Features: - Automatic repository creation/connection - Group management with validation - Session management with context managers - Integrated logging with file contexts - Configurable compression and chunking
Note on "metadata"¶
This class manages two distinct things both historically called "metadata":
-
File registry (
{group}/metadata/table): per-file ingest ledger tracking hashes, temporal ranges, filenames, and paths. Managed byappend_metadata(),load_metadata(),backup_metadata_table(), etc. -
Store metadata (
canvod.store_metadatapackage): store-level provenance (identity, creator, environment, compliance). Written to Zarr root attrs by the orchestrator. Seecanvod-store-metadata.
Parameters¶
store_path : Path Path to the Icechunk store directory. store_type : str, default "rinex_store" Type of store ("rinex_store" or "vod_store"). compression_level : int | None, optional Override default compression level. compression_algorithm : str | None, optional Override default compression algorithm.
Attributes¶
store_path : Path Path to the Icechunk store directory. store_type : str Type of store ("rinex_store" or "vod_store"). compression_level : int Compression level (1-9). compression_algorithm : icechunk.CompressionAlgorithm Compression algorithm enum. repo : icechunk.Repository The Icechunk repository instance.
Source code in packages/canvod-store/src/canvod/store/store.py
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 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 | |
repo
property
¶
Get the repository instance.
source_format
property
¶
Return the source_format root attribute, or None.
tree
property
¶
Display hierarchical tree of all branches, groups, and subgroups.
__init__(store_path, store_type='rinex_store', compression_level=None, compression_algorithm=None)
¶
Initialize the Icechunk store manager.
Parameters¶
store_path : Path Path to the Icechunk store directory. store_type : str, default "rinex_store" Type of store ("rinex_store" or "vod_store"). compression_level : int | None, optional Override default compression level. compression_algorithm : str | None, optional Override default compression algorithm.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
readonly_session(branch='main')
¶
Context manager for readonly sessions.
Parameters¶
branch : str, default "main" Branch name.
Returns¶
Generator[icechunk.ReadonlySession, None, None] Readonly session context manager.
Source code in packages/canvod-store/src/canvod/store/store.py
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
writable_session(branch='main')
¶
Context manager for writable sessions.
Parameters¶
branch : str, default "main" Branch name.
Returns¶
Generator[icechunk.WritableSession, None, None] Writable session context manager.
Source code in packages/canvod-store/src/canvod/store/store.py
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | |
set_root_attrs(attrs, branch='main')
¶
Set root-level Zarr attributes on the store.
Parameters¶
attrs : dict[str, Any] Key-value pairs to merge into root attrs. branch : str, default "main" Branch to write to.
Returns¶
str Snapshot ID from the commit.
Source code in packages/canvod-store/src/canvod/store/store.py
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | |
get_root_attrs(branch='main')
¶
Read root-level Zarr attributes from the store.
Returns¶
dict[str, Any] Root attributes (empty dict if none set).
Source code in packages/canvod-store/src/canvod/store/store.py
281 282 283 284 285 286 287 288 289 290 291 292 293 294 | |
get_branch_names()
¶
List all branches in the store.
Returns¶
list[str] List of branch names.
Source code in packages/canvod-store/src/canvod/store/store.py
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 | |
get_group_names(branch=None)
¶
List all groups in the store.
Parameters¶
branch: Optional[str] Repository branch to examine. Defaults to listing groups from all branches.
Returns¶
dict[str, list[str]] Dictionary mapping branch names to lists of group names.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
list_groups(branch='main')
¶
List all groups in a branch.
Parameters¶
branch : str Branch name (default: "main")
Returns¶
list[str] List of group names in the branch
Source code in packages/canvod-store/src/canvod/store/store.py
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | |
print_tree(max_depth=None)
¶
Display hierarchical tree of all branches, groups, and subgroups.
Parameters¶
max_depth : int | None Maximum depth to display. None for unlimited depth. - 0: Only show branches - 1: Show branches and top-level groups - 2: Show branches, groups, and first level of subgroups/arrays - etc.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
group_exists(group_name, branch='main')
¶
Check if a group exists.
Parameters¶
group_name : str Name of the group to check. branch : str, default "main" Repository branch to examine.
Returns¶
bool True if the group exists, False otherwise.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
read_group(group_name, branch='main', time_slice=None, date=None, chunks=None)
¶
Read data from a group.
Parameters¶
group_name : str
Name of the group to read.
branch : str, default "main"
Repository branch.
time_slice : slice | None, optional
Optional label-based time slice for filtering (passed to ds.sel).
date : str | None, optional
YYYYDOY string (e.g. "2025001") selecting a single calendar day.
Converted to a time_slice; mutually exclusive with time_slice.
chunks : dict[str, Any] | None, optional
Chunking specification (uses config defaults if None).
Returns¶
xr.Dataset Dataset from the group.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
read_group_deduplicated(group_name, branch='main', keep='last', time_slice=None, chunks=None)
¶
Read data from a group with automatic deduplication.
This method calls read_group() then removes duplicates using metadata table intelligence when available, falling back to simple epoch deduplication.
Parameters¶
group_name : str Name of the group to read. branch : str, default "main" Repository branch. keep : str, default "last" Deduplication strategy for duplicate epochs. time_slice : slice | None, optional Optional time slice for filtering. chunks : dict[str, Any] | None, optional Chunking specification (uses config defaults if None).
Returns¶
xr.Dataset Dataset with duplicates removed (latest data only).
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
write_dataset(dataset, group_name, session, mode='a', chunks=None)
¶
Write a dataset to Icechunk with proper chunking.
Parameters¶
dataset : xr.Dataset Dataset to write group_name : str Group path in store session : Any Active writable session or store handle. mode : str Write mode: 'w' (overwrite) or 'a' (append) chunks : dict[str, int] | None Chunking spec. If None, uses store's chunk_strategy. Example: {'epoch': 34560, 'sid': -1}
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
write_initial_group(dataset, group_name, branch='main', commit_message=None)
¶
Write initial data to a new group.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
backup_metadata_table(group_name, session)
¶
Backup the metadata table to a Polars DataFrame.
Parameters¶
group_name : str Group name. session : Any Active session for reading.
Returns¶
pl.DataFrame | None DataFrame with metadata rows, or None if missing.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
restore_metadata_table(group_name, df, session)
¶
Restore the metadata table from a Polars DataFrame.
This recreates the full Zarr structure for the metadata table.
Parameters¶
group_name : str Group name. df : pl.DataFrame Metadata table to restore. session : Any Active session for writing.
Returns¶
None
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
overwrite_file_in_group(dataset, group_name, rinex_hash, start, end, branch='main', commit_message=None)
¶
Overwrite a file's contribution to the group (same hash, new epoch range).
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
get_group_info(group_name, branch='main')
¶
Get metadata about a group.
Parameters¶
group_name : str Name of the group. branch : str, default "main" Repository branch to examine.
Returns¶
dict[str, Any] Group metadata.
Raises¶
ValueError If the group does not exist.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
metadata_dataset_exists(group_name, name, branch='main')
¶
Return True if a metadata dataset name exists for group_name.
Source code in packages/canvod-store/src/canvod/store/store.py
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 | |
write_metadata_dataset(meta_ds, group_name, name, branch='main')
¶
Write a pre-concatenated metadata dataset to {group_name}/metadata/{name}.
Always writes with mode="w" (full overwrite for the day).
Parameters¶
meta_ds : xr.Dataset
Pre-concatenated (epoch, sid) metadata dataset.
group_name : str
Target group (receiver name).
name : str
Dataset name under metadata/ (e.g. "sbf_obs").
branch : str, default "main"
Repository branch to write to.
Returns¶
str Icechunk snapshot ID.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_metadata_datasets(parts, group_name, name, branch='main')
¶
Write metadata datasets incrementally — no in-memory concat.
The first dataset initialises the group (mode="w"), subsequent
datasets are appended along epoch. All writes happen inside a
single session/commit so the operation is atomic.
Parameters¶
parts : list[xr.Dataset]
Individual per-file metadata datasets with an epoch dim.
group_name : str
Target group (receiver name).
name : str
Dataset name under metadata/ (e.g. "sbf_obs").
branch : str, default "main"
Repository branch to write to.
Returns¶
str Icechunk snapshot ID.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
read_metadata_dataset(group_name, name, branch='main', chunks=None)
¶
Read a metadata dataset name for group_name.
Parameters¶
group_name : str
Group (receiver) name.
name : str
Dataset name under metadata/ (e.g. "sbf_obs").
branch : str, default "main"
Repository branch.
chunks : dict | None, optional
Dask chunk specification. Defaults to
{"epoch": 34560, "sid": -1}.
Returns¶
xr.Dataset
Lazy (epoch, sid) metadata dataset.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
get_metadata_dataset_info(group_name, name, branch='main')
¶
Get info about metadata dataset name for group_name.
Parameters¶
group_name : str
Group (receiver) name.
name : str
Dataset name under metadata/ (e.g. "sbf_obs").
branch : str, default "main"
Repository branch.
Returns¶
dict[str, Any]
Info dict with the same structure as get_group_info().
Raises¶
ValueError If the metadata dataset does not exist.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
sbf_metadata_exists(group_name, branch='main')
¶
Return True if an SBF metadata dataset exists for group_name.
Source code in packages/canvod-store/src/canvod/store/store.py
1211 1212 1213 | |
write_sbf_metadata(meta_ds, group_name, branch='main')
¶
Write SBF metadata dataset.
Source code in packages/canvod-store/src/canvod/store/store.py
1215 1216 1217 1218 1219 | |
read_sbf_metadata(group_name, branch='main', chunks=None)
¶
Read SBF metadata dataset.
Source code in packages/canvod-store/src/canvod/store/store.py
1221 1222 1223 1224 1225 | |
get_sbf_metadata_info(group_name, branch='main')
¶
Get SBF metadata info.
Source code in packages/canvod-store/src/canvod/store/store.py
1227 1228 1229 1230 1231 | |
rel_path_for_commit(file_path)
¶
Generate relative path for commit messages.
Parameters¶
file_path : Path Full file path.
Returns¶
str Relative path string with log_path_depth parts.
Source code in packages/canvod-store/src/canvod/store/store.py
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 | |
get_store_stats()
¶
Get statistics about the store.
Returns¶
dict[str, Any] Store statistics.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_to_group(dataset, group_name, append_dim='epoch', branch='main', action='write', commit_message=None)
¶
Append data to an existing group.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
write_or_append_group(dataset, group_name, append_dim='epoch', branch='main', commit_message=None, dedup=False)
¶
Write or append a dataset to a group.
By default (dedup=False) no guardrails are applied — suitable for
VOD stores and other derived-data stores where rinex-style dedup does
not apply.
When dedup=True the method runs a full hash-match + temporal-overlap
check (via :meth:should_skip_file) before opening a write session.
This makes the store the authoritative final gate for RINEX/SBF ingest
paths, backstopping any pre-checks in the caller.
If the group does not exist, creates it (mode='w').
If it exists, appends along append_dim.
Parameters¶
dataset : xr.Dataset
Dataset to write or append.
group_name : str
Target Icechunk group.
append_dim : str, default "epoch"
Dimension along which to append when the group already exists.
branch : str, default "main"
Icechunk branch to write to.
commit_message : str or None
Commit message. Auto-generated if None.
dedup : bool, default False
When True, check for duplicate hash or temporal overlap before
writing. If the dataset would be a duplicate, the write is skipped,
a warning is logged, and False is returned. Set to True for
RINEX/SBF ingest; leave False for VOD and derived-data stores.
Returns¶
bool
True if the dataset was written, False if skipped
(only possible when dedup=True).
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_metadata(group_name, rinex_hash, start, end, snapshot_id, action, commit_msg, dataset_attrs, branch='main', canonical_name=None, physical_path=None)
¶
Append a metadata row into the group_name/metadata/table.
Schema
index int64 (continuous row id) rinex_hash str (UTF-8, VariableLengthUTF8) start datetime64[ns] end datetime64[ns] snapshot_id str (UTF-8) action str (UTF-8, e.g. "insert"|"append"|"overwrite"|"skip") commit_msg str (UTF-8) written_at str (UTF-8, ISO8601 with timezone) write_strategy str (UTF-8, RINEX_STORE_STRATEGY or VOD_STORE_STRATEGY) attrs str (UTF-8, JSON dump of dataset attrs)
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_metadata_bulk(group_name, rows, session=None)
¶
Append multiple metadata rows in one commit.
Parameters¶
group_name : str Group name (e.g. "canopy", "reference") rows : list[dict[str, Any]] List of metadata records matching the schema used in append_metadata(). session : icechunk.WritableSession, optional If provided, rows are written into this session (caller commits later). If None, this method opens its own writable session and commits once.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
load_metadata(store, group_name)
¶
Load metadata directly from Zarr into a Polars DataFrame.
Parameters¶
store : Any Zarr store or session store handle. group_name : str Group name.
Returns¶
pl.DataFrame Metadata table.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
read_metadata_table(session, group_name)
¶
Read the metadata table from a session.
Parameters¶
session : Any Active session for reading. group_name : str Group name.
Returns¶
pl.DataFrame Metadata table.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
metadata_row_exists(group_name, rinex_hash, start, end, branch='main')
¶
Check whether a file already exists or temporally overlaps existing data.
Performs two checks in order:
- Hash match — if
rinex_hashalready appears in the metadata table, the file was previously ingested (exact duplicate). - Temporal overlap — if the incoming
[start, end]interval overlaps any existing metadata interval, the file covers a time range that is already (partially) present in the store. This catches cases like a daily concatenation file coexisting with the sub-daily files it was built from.
Parameters¶
group_name : str Icechunk group name. rinex_hash : str Hash of the current GNSS dataset. start : np.datetime64 Start epoch of the incoming file. end : np.datetime64 End epoch of the incoming file. branch : str, default "main" Branch name in the Icechunk repository.
Returns¶
tuple[bool, pl.DataFrame]
(True, overlapping_rows) when the file should be skipped,
(False, empty_df) when it is safe to ingest.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
should_skip_file(group_name, file_hash, time_start, time_end, branch='main')
¶
Check whether a file should be skipped before processing and writing.
Thin public wrapper around :meth:metadata_row_exists that returns a
simple (skip, reason) pair instead of a DataFrame, suitable for use
in Airflow task functions as an early-exit optimisation.
This method is an early-exit optimisation: it avoids opening a write
session for files that are already present. Pass dedup=True to
:meth:write_or_append_group to make the store the authoritative
final gate (runs the same check again before writing).
Checks performed (in order):
- Hash match — file was previously ingested (exact duplicate).
- Temporal overlap — incoming time range overlaps existing epochs.
Layer 3 (intra-batch overlap) is not applicable here because task functions process files one at a time.
Parameters¶
group_name : str
Icechunk group name.
file_hash : str or None
Hash from dataset.attrs["File Hash"]. When None the check
is skipped and (False, "") is returned.
time_start : np.datetime64
First epoch of the incoming dataset.
time_end : np.datetime64
Last epoch of the incoming dataset.
branch : str, default "main"
Branch name in the Icechunk repository.
Returns¶
tuple[bool, str]
(True, "hash_match") — exact duplicate, skip.
(True, "temporal_overlap") — overlapping time range, skip.
(False, "") — safe to ingest.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
batch_check_existing(group_name, file_hashes)
¶
Check which file hashes already exist in metadata.
Source code in packages/canvod-store/src/canvod/store/store.py
1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 | |
check_temporal_overlaps(group_name, file_intervals, branch='main')
¶
Check which files temporally overlap existing metadata intervals.
Parameters¶
group_name : str
Icechunk group name.
file_intervals : list[tuple[str, np.datetime64, np.datetime64]]
List of (rinex_hash, start, end) tuples for incoming files.
branch : str, default "main"
Branch name in the Icechunk repository.
Returns¶
set[str]
Hashes of files whose [start, end] overlaps any existing
metadata interval. Files whose hash already exists in the store
are NOT included (use batch_check_existing for those).
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
append_metadata_bulk_store(group_name, rows, store)
¶
Append metadata rows into an open transaction store.
Parameters¶
group_name : str Group name (e.g. "canopy", "reference"). rows : list[dict[str, Any]] Metadata rows to append. store : Any Open Icechunk transaction store.
Source code in packages/canvod-store/src/canvod/store/store.py
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 | |
expire_old_snapshots(days=None, branch='main', delete_expired_branches=True, delete_expired_tags=True)
¶
Expire and garbage-collect snapshots older than the given retention period.
Parameters¶
days : int | None, optional Number of days to retain snapshots. Defaults to config value. branch : str, default "main" Branch to apply expiration on. delete_expired_branches : bool, default True Whether to delete branches pointing to expired snapshots. delete_expired_tags : bool, default True Whether to delete tags pointing to expired snapshots.
Returns¶
set[str] Expired snapshot IDs.
Source code in packages/canvod-store/src/canvod/store/store.py
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 2084 2085 2086 | |
get_history(branch='main', limit=None)
¶
Return commit ancestry (history) for a branch.
Parameters¶
branch : str, default "main" Branch name. limit : int | None, optional Maximum number of commits to return.
Returns¶
list[dict] Commit info dictionaries (id, message, written_at, parent_ids).
Source code in packages/canvod-store/src/canvod/store/store.py
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 | |
print_history(branch='main', limit=100)
¶
Pretty-print the ancestry for quick inspection.
Source code in packages/canvod-store/src/canvod/store/store.py
2121 2122 2123 2124 2125 2126 2127 | |
__repr__()
¶
Return the developer-facing representation.
Returns¶
str Representation string.
Source code in packages/canvod-store/src/canvod/store/store.py
2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 | |
__str__()
¶
Return a human-readable summary.
Returns¶
str Summary string.
Source code in packages/canvod-store/src/canvod/store/store.py
2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 | |
rechunk_group(group_name, chunks, source_branch='main', temp_branch=None, promote_to_main=True, delete_temp_branch=True)
¶
Rechunk a group with optimal chunk sizes.
Parameters¶
group_name : str Name of the group to rechunk chunks : dict[str, int] Chunking specification, e.g. {'epoch': 34560, 'sid': -1} source_branch : str Branch to read original data from (default: "main") temp_branch : str | None Temporary branch name for rechunked data. If None, uses "{group_name}_rechunked". promote_to_main : bool If True, reset main branch to rechunked snapshot after writing delete_temp_branch : bool If True, delete temporary branch after promotion (only if promote_to_main=True).
Returns¶
str Snapshot ID of the rechunked data
Source code in packages/canvod-store/src/canvod/store/store.py
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 | |
rechunk_group_verbose(group_name, chunks=None, source_branch='main', temp_branch=None, promote_to_main=True, delete_temp_branch=True)
¶
Rechunk a group with optimal chunk sizes.
Parameters¶
group_name : str
Name of the group to rechunk
chunks : dict[str, int] | None
Chunking specification, e.g. {'epoch': 34560, 'sid': -1}. Defaults
to gnnsvodpy.globals.ICECHUNK_CHUNK_STRATEGIES.
source_branch : str
Branch to read original data from (default: "main")
temp_branch : str | None
Temporary branch name for rechunked data. If None, uses
"{group_name}_rechunked".
promote_to_main : bool
If True, reset main branch to rechunked snapshot after writing
delete_temp_branch : bool
If True, delete temporary branch after promotion (only if
promote_to_main=True).
Returns¶
str Snapshot ID of the rechunked data
Source code in packages/canvod-store/src/canvod/store/store.py
2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 | |
create_release_tag(tag_name, snapshot_id=None)
¶
Create an immutable tag for an important version.
Parameters¶
tag_name : str Name for the tag (e.g., "v2024_complete", "before_reprocess") snapshot_id : str | None Snapshot to tag. If None, uses current tip of main branch.
Source code in packages/canvod-store/src/canvod/store/store.py
2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 | |
list_tags()
¶
List all tags in the repository.
Source code in packages/canvod-store/src/canvod/store/store.py
2458 2459 2460 | |
delete_tag(tag_name)
¶
Delete a tag (use with caution - tags are meant to be permanent).
Source code in packages/canvod-store/src/canvod/store/store.py
2462 2463 2464 2465 | |
plot_commit_graph(max_commits=100)
¶
Visualize commit history as an interactive git-like graph.
Creates an interactive visualization showing: - Branches with different colors - Chronological commit ordering - Branch divergence points - Commit messages on hover - Click to see commit details
Parameters¶
max_commits : int Maximum number of commits to display (default: 100).
Returns¶
Figure Interactive plotly figure (works in marimo and Jupyter).
Source code in packages/canvod-store/src/canvod/store/store.py
2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 | |
cleanup_stale_branches(keep_patterns=None)
¶
Delete stale temporary branches (e.g., from failed rechunking).
Parameters¶
keep_patterns : list[str] | None Patterns to preserve. Default: ["main", "dev"]
Returns¶
list[str] Names of deleted branches
Source code in packages/canvod-store/src/canvod/store/store.py
2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 | |
delete_branch(branch_name)
¶
Delete a branch.
Source code in packages/canvod-store/src/canvod/store/store.py
2785 2786 2787 2788 2789 2790 2791 | |
get_snapshot_info(snapshot_id)
¶
Get detailed information about a specific snapshot.
Parameters¶
snapshot_id : str Snapshot ID to inspect
Returns¶
dict Snapshot metadata and statistics
Source code in packages/canvod-store/src/canvod/store/store.py
2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 | |
compare_snapshots(snapshot_id_1, snapshot_id_2)
¶
Compare two snapshots to see what changed.
Parameters¶
snapshot_id_1 : str First snapshot (older) snapshot_id_2 : str Second snapshot (newer)
Returns¶
dict Comparison results showing added/removed/modified groups
Source code in packages/canvod-store/src/canvod/store/store.py
2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 | |
maintenance(expire_days=7, cleanup_branches=True, run_gc=True)
¶
Run full maintenance on the store.
Parameters¶
expire_days : int Days of snapshot history to keep cleanup_branches : bool Remove stale temporary branches run_gc : bool Run garbage collection after expiration
Returns¶
dict Summary of maintenance actions
Source code in packages/canvod-store/src/canvod/store/store.py
2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 | |
sanitize_store(source_branch='main', temp_branch='sanitize_temp', promote_to_main=True, delete_temp_branch=True)
¶
Sanitize all groups by removing NaN-only SIDs and cleaning coordinates.
Creates a temporary branch, applies sanitization to all groups, then optionally promotes to main and cleans up.
Parameters¶
source_branch : str, default "main" Branch to read original data from. temp_branch : str, default "sanitize_temp" Temporary branch name for sanitized data. promote_to_main : bool, default True If True, reset main branch to sanitized snapshot after writing. delete_temp_branch : bool, default True If True, delete temporary branch after promotion.
Returns¶
str Snapshot ID of the sanitized data.
Source code in packages/canvod-store/src/canvod/store/store.py
2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 | |
safe_temporal_aggregate(group, freq='1D', vars_to_aggregate=('VOD',), geometry_vars=('phi', 'theta'), drop_empty=True, branch='main')
¶
Aggregate temporally irregular VOD data per SID.
Each satellite (SID) is aggregated independently within each time bin. Mixing observations across satellites is physically meaningless because each observes a different part of the canopy from a different sky position.
.. note::
For production use, prefer canvod.ops.TemporalAggregate
which uses Polars groupby and handles all coordinate types
explicitly. This method is a convenience wrapper for quick
interactive exploration.
Parameters¶
group : str Group name to aggregate. freq : str, default "1D" Resample frequency string. vars_to_aggregate : Sequence[str], optional Variables to aggregate using mean. geometry_vars : Sequence[str], optional Geometry variables to aggregate using mean (centroid of contributing sky positions). drop_empty : bool, default True Drop empty epochs after aggregation. branch : str, default "main" Branch name to read from.
Returns¶
xr.Dataset Aggregated dataset with independent per-SID aggregation.
Source code in packages/canvod-store/src/canvod/store/store.py
3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 | |
safe_temporal_aggregate_to_branch(source_group, target_group, target_branch, freq='1D', overwrite=False, **kwargs)
¶
Aggregate a group and save to a new Icechunk branch/group.
Parameters¶
source_group : str Source group name. target_group : str Target group name. target_branch : str Target branch name. freq : str, default "1D" Resample frequency string. overwrite : bool, default False Whether to overwrite an existing branch. **kwargs : Any Additional keyword args passed to safe_temporal_aggregate().
Returns¶
xr.Dataset Aggregated dataset written to the target branch.
Source code in packages/canvod-store/src/canvod/store/store.py
3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 | |
create_rinex_store(store_path)
¶
Create a RINEX Icechunk store with appropriate configuration.
Parameters¶
store_path : Path Path to the store directory.
Returns¶
MyIcechunkStore Configured store for RINEX data.
Source code in packages/canvod-store/src/canvod/store/store.py
3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 | |
create_vod_store(store_path)
¶
Create a VOD Icechunk store with appropriate configuration.
Parameters¶
store_path : Path Path to the store directory.
Returns¶
MyIcechunkStore Configured store for VOD analysis data.
Source code in packages/canvod-store/src/canvod/store/store.py
3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 | |
write_vod_to_store(vod_store, group_name, vod_ds, canopy_hash, sky_hash, commit_msg='VOD calculation')
¶
Write VOD data to store with metadata tracking.
Source code in packages/canvod-store/src/canvod/store/store.py
3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 | |
Data Reader¶
Icechunk-backed readers for RINEX datasets.
IcechunkDataReader
¶
Replacement for RinexFilesParser that reads from Icechunk stores.
This class provides a similar interface to the old parser but reads pre-processed data from Icechunk stores instead of processing RINEX files.
Parameters¶
matched_dirs : MatchedDirs Directory information for date/location matching site_name : str, optional Name of research site (defaults to DEFAULT_RESEARCH_SITE) n_max_workers : int, optional Maximum number of workers for parallel operations (defaults to N_MAX_THREADS) enable_gc : bool, optional Whether to enable garbage collection between operations (default True) gc_delay : float, optional Delay in seconds after garbage collection (default 1.0)
Source code in packages/canvod-store/src/canvod/store/reader.py
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 | |
__init__(matched_dirs, site_name=None, n_max_workers=None, enable_gc=True, gc_delay=1.0)
¶
Initialize the Icechunk data reader.
Parameters¶
matched_dirs : MatchedDirs
Directory information for date/location matching.
site_name : str | None, optional
Name of research site. If None, uses the first site from config.
n_max_workers : int | None, optional
Maximum number of workers for parallel operations. Defaults to config.
enable_gc : bool, optional
Whether to enable garbage collection between operations.
gc_delay : float, optional
Delay in seconds after garbage collection.
Source code in packages/canvod-store/src/canvod/store/reader.py
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 | |
__del__()
¶
Ensure the pool is shut down when the reader is deleted.
Source code in packages/canvod-store/src/canvod/store/reader.py
200 201 202 203 204 205 | |
get_receiver_by_type(receiver_type)
¶
Get list of receiver names by type.
Parameters¶
receiver_type : str Type of receiver ('canopy', 'reference')
Returns¶
list[str] List of receiver names of the specified type
Source code in packages/canvod-store/src/canvod/store/reader.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | |
parsed_rinex_data_gen_v2(keep_vars=None, receiver_types=None)
¶
Generator that processes RINEX files, augments them (φ, θ, r), and appends to Icechunk stores on-the-fly.
Yields enriched daily datasets (already augmented).
Source code in packages/canvod-store/src/canvod/store/reader.py
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 | |
parsed_rinex_data_gen(keep_vars=None, receiver_types=None)
¶
Generator that processes RINEX files and appends to Icechunk stores on-the-fly.
Parameters¶
keep_vars : list[str], optional List of variables to keep in datasets receiver_types : list[str], optional List of receiver types to process ('canopy', 'reference'). If None, defaults to ['canopy', 'reference']
Yields¶
xr.Dataset Processed and ingested datasets for each receiver type, in order
Source code in packages/canvod-store/src/canvod/store/reader.py
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 | |
get_available_receivers()
¶
Get available receivers grouped by type.
Returns¶
dict[str, list[str]] Dictionary mapping receiver types to lists of receiver names.
Source code in packages/canvod-store/src/canvod/store/reader.py
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 | |
__str__()
¶
Return a human-readable summary.
Returns¶
str Summary string.
Source code in packages/canvod-store/src/canvod/store/reader.py
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 | |
preprocess_rnx(rnx_file, keep_vars=None)
¶
Preprocess a single RINEX file and attach file hash metadata.
Parameters¶
rnx_file : Path RINEX file to preprocess. keep_vars : list[str] | None, optional Variables to retain in the dataset.
Returns¶
tuple[Path, xr.Dataset] The input file path and the processed dataset.
Source code in packages/canvod-store/src/canvod/store/reader.py
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 | |
Preprocessing¶
Preprocessing wrapper for Icechunk storage.
This module provides the IcechunkPreprocessor class which wraps preprocessing functions from canvod.auxiliary.preprocessing. It maintains backward compatibility with gnssvodpy code while delegating to the new modular implementation.
IcechunkPreprocessor
¶
Handles preprocessing of RINEX-converted datasets before writing to Icechunk.
This class wraps functions from canvod.auxiliary.preprocessing to provide backward compatibility with existing gnssvodpy code.
Note
All methods now delegate to canvod.auxiliary.preprocessing functions. The aggregate_glonass_fdma parameter should be passed from configuration.
Source code in packages/canvod-store/src/canvod/store/preprocessing.py
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 | |
map_aux_sv_to_sid(aux_ds, fill_value=None, aggregate_glonass_fdma=True)
staticmethod
¶
Transform auxiliary dataset from sv → sid dimension.
Delegates to canvod.auxiliary.preprocessing.map_aux_sv_to_sid()
Parameters¶
aux_ds : xr.Dataset Dataset with 'sv' dimension fill_value : float, optional Fill value for missing entries (default: np.nan) aggregate_glonass_fdma : bool, default True Whether to aggregate GLONASS FDMA bands
Returns¶
xr.Dataset Dataset with 'sid' dimension replacing 'sv'
Source code in packages/canvod-store/src/canvod/store/preprocessing.py
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 | |
pad_to_global_sid(ds, keep_sids=None, aggregate_glonass_fdma=True)
staticmethod
¶
Pad dataset so it has all possible SIDs across all constellations.
Delegates to canvod.auxiliary.preprocessing.pad_to_global_sid()
Parameters¶
ds : xr.Dataset Dataset with 'sid' dimension keep_sids : list[str] | None Optional list of specific SIDs to keep aggregate_glonass_fdma : bool, default True Whether to aggregate GLONASS FDMA bands
Returns¶
xr.Dataset Dataset padded with NaN for missing SIDs
Source code in packages/canvod-store/src/canvod/store/preprocessing.py
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 | |
normalize_sid_dtype(ds)
staticmethod
¶
Ensure sid coordinate uses object dtype.
Delegates to canvod.auxiliary.preprocessing.normalize_sid_dtype()
Parameters¶
ds : xr.Dataset Dataset with 'sid' coordinate
Returns¶
xr.Dataset Dataset with sid as object dtype
Source code in packages/canvod-store/src/canvod/store/preprocessing.py
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 | |
strip_fillvalue(ds)
staticmethod
¶
Remove _FillValue attrs/encodings.
Delegates to canvod.auxiliary.preprocessing.strip_fillvalue()
Parameters¶
ds : xr.Dataset Dataset to clean
Returns¶
xr.Dataset Dataset with _FillValue attributes removed
Source code in packages/canvod-store/src/canvod/store/preprocessing.py
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | |
add_future_datavars(ds, var_config)
staticmethod
¶
Add placeholder data variables from configuration.
Delegates to canvod.auxiliary.preprocessing.add_future_datavars()
Parameters¶
ds : xr.Dataset Dataset to add variables to var_config : dict[str, dict[str, Any]] Variable configuration dictionary
Returns¶
xr.Dataset Dataset with new variables added
Source code in packages/canvod-store/src/canvod/store/preprocessing.py
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | |
prep_aux_ds(aux_ds, fill_value=None, aggregate_glonass_fdma=True, keep_sids=None)
staticmethod
¶
Preprocess auxiliary dataset before writing to Icechunk.
Delegates to canvod.auxiliary.preprocessing.prep_aux_ds()
Performs complete 4-step preprocessing: 1. Convert sv → sid dimension 2. Pad to global sid list or filter to keep_sids 3. Normalize sid dtype to object 4. Strip _FillValue attributes
Parameters¶
aux_ds : xr.Dataset Dataset with 'sv' dimension fill_value : float, optional Fill value for missing entries (default: np.nan) aggregate_glonass_fdma : bool, default True Whether to aggregate GLONASS FDMA bands keep_sids : list[str] | None, default None List of specific SIDs to keep. If None, keeps all possible SIDs.
Returns¶
xr.Dataset Fully preprocessed dataset ready for Icechunk
Source code in packages/canvod-store/src/canvod/store/preprocessing.py
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 | |