Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Added a catalog of instruments from past and present missions, with a standard for validating them. Fixed instruments losing their fields when serialized. Instruments now reject unknown fields, which can break code that passes misspelled or unused arguments.

Added:
- Module `catalog` of instruments from past and present missions (`get_entry`, `list_entries`), starting with GOES-R ABI, GPM GMI, GCOM-W AMSR2, ATMS, CrIS, VIIRS, MODIS, Landsat OLI, Sentinel-2 MSI, Sentinel-1 C-SAR, NISAR L-SAR, SWOT KaRIn, the SMAP radiometer, IASI, Sentinel-5P TROPOMI, GPM DPR, MHS, ICESat-2 ATLAS, AIRS, AMSU-A, AVHRR, SSMIS, Sentinel-3 OLCI, PACE OCI, HARP2, and SPEXone, the OMPS Nadir Mapper, Himawari AHI, CERES, ECOSTRESS, OCO-2, the Sentinel-6 Poseidon-4 altimeter, Metop ASCAT, TEMPO, GEDI, and EMIT. `InstrumentEntry.to_satellite` and `build` give an entry's instruments with the attitude they were validated with, and `InstrumentEntry.validation` gives its validation tier, computed from its results and the thresholds of the validation standard (`docs/validation/standard.rst`). GMI, ATMS, VIIRS, MODIS, OLI, MSI, KaRIn, TROPOMI, DPR, MHS, HARP2, SPEXone, Poseidon-4, ASCAT, and TEMPO are `validated`, each with stated limitations, and ABI, AMSR2, CrIS, C-SAR, L-SAR, the SMAP radiometer, IASI, ATLAS, AIRS, AMSU-A, AVHRR, SSMIS, OLCI, OCI, OMPS, AHI, CERES, ECOSTRESS, OCO-2, GEDI, and EMIT are `partial` and list their gaps. Results on sibling satellites (NOAA-21, Metop-B, Sentinel-1D, Sentinel-6B) are recorded as transfers, which warn on use and do not count toward a tier; ATMS and VIIRS also have configurations fitted on NOAA-21, validated on held-out data, as NOAA-20's angles did not transfer. In an entry with configurations fitted on more than one platform (ATMS, VIIRS, and the OMPS Nadir Mapper), each configuration's name ends with its platform (`swath_noaa_20`, `swath_noaa_21`). Version 2 of the standard adds a lidar class, for ATLAS, version 3 an altimeter class, for Poseidon-4, version 4 a scatterometer class, for ASCAT, with the gates of the SAR class, and version 5 a regional geostationary class, for TEMPO, whose gate is the intersection over union of the field of regard with the area a scan images; none changes a threshold of an earlier version. Every pointed configuration with a view tailored to the time step is swept (`is_swept`), so its swaths do not depend on the time step; its records were rescored with swept swaths on the same held-out data, and MSI, TROPOMI, DPR, OCI's swath, and C-SAR's EW mode, whose tiers changed, were tested again on a later held-out day, with the rescored results stated in their limitations. The documentation lists the entries and their results on a page written from the catalog (`docs/validation/catalog_page.py`), and the example `UseInstrumentCatalog` shows their use. The OSSE examples `RunOSSEMonsoon` and `RunOSSEHurricane` take their ATMS and CrIS swaths from the catalog.
- Module `catalog` of instruments from past and present missions (`get_entry`, `list_entries`), starting with GOES-R ABI, GPM GMI, GCOM-W AMSR2, ATMS, CrIS, VIIRS, MODIS, Landsat OLI, Sentinel-2 MSI, Sentinel-1 C-SAR, NISAR L-SAR, SWOT KaRIn, the SMAP radiometer, IASI, Sentinel-5P TROPOMI, GPM DPR, MHS, ICESat-2 ATLAS, AIRS, AMSU-A, AVHRR, SSMIS, Sentinel-3 OLCI, PACE OCI, HARP2, and SPEXone, the OMPS Nadir Mapper, Himawari AHI, CERES, ECOSTRESS, OCO-2, the Sentinel-6 Poseidon-4 altimeter, Metop ASCAT, TEMPO, GEDI, EMIT, EarthCARE ATLID, BBR, CPR, and MSI, and TRMM PR, TMI, and VIRS. `InstrumentEntry.to_satellite` and `build` give an entry's instruments with the attitude they were validated with, and `InstrumentEntry.validation` gives its validation tier, computed from its results and the thresholds of the validation standard (`docs/validation/standard.rst`). GMI, ATMS, VIIRS, MODIS, OLI, MSI, KaRIn, TROPOMI, DPR, MHS, HARP2, SPEXone, Poseidon-4, ASCAT, TEMPO, TMI, VIRS, and EarthCARE's MSI are `validated`, each with stated limitations, and ABI, AMSR2, CrIS, C-SAR, L-SAR, the SMAP radiometer, IASI, ATLAS, AIRS, AMSU-A, AVHRR, SSMIS, OLCI, OCI, OMPS, AHI, CERES, ECOSTRESS, OCO-2, GEDI, EMIT, ATLID, BBR, CPR, and TRMM PR are `partial` and list their gaps. Results on sibling satellites (NOAA-21, Metop-B, Sentinel-1D, Sentinel-6B) are recorded as transfers, which warn on use and do not count toward a tier; ATMS and VIIRS also have configurations fitted on NOAA-21, validated on held-out data, as NOAA-20's angles did not transfer. In an entry with configurations fitted on more than one platform (ATMS, VIIRS, and the OMPS Nadir Mapper), each configuration's name ends with its platform (`swath_noaa_20`, `swath_noaa_21`). Version 2 of the standard adds a lidar class, for ATLAS, version 3 an altimeter class, for Poseidon-4, version 4 a scatterometer class, for ASCAT, with the gates of the SAR class, version 5 a regional geostationary class, for TEMPO, whose gate is the intersection over union of the field of regard with the area a scan images, and version 6 a profiler class, for ATLID and CPR, with the gates of the altimeter class; none changes a threshold of an earlier version. Every pointed configuration with a view tailored to the time step is swept (`is_swept`), so its swaths do not depend on the time step; its records were rescored with swept swaths on the same held-out data, and MSI, TROPOMI, DPR, OCI's swath, and C-SAR's EW mode, whose tiers changed, were tested again on a later held-out day, with the rescored results stated in their limitations. The documentation lists the entries and their results on a page written from the catalog (`docs/validation/catalog_page.py`), and the example `UseInstrumentCatalog` shows their use. The OSSE examples `RunOSSEMonsoon` and `RunOSSEHurricane` take their ATMS and CrIS swaths from the catalog.
- Class `catalog.TiltSchedule` and field `attitude_schedule` of catalog configurations, for an attitude that changes by day, as PACE's tilt does: `build` and `to_satellite` take the `start` and `end` of the analysis and give an `AttitudeSchedule` with an attitude for each day (UTC), blind while the tilt changes. Function `catalog.get_subsolar_latitude` gives the latitude of the subsolar point.
- Field `type` of a catalog configuration's `attitude` (`attitude`, `glint`, or `target`), which builds an `Attitude`, `GlintAttitude`, or `TargetAttitude`, as for OCO-2's glint mode.
- Field `blind_intervals` of `Attitude`: intervals of argument of latitude in which a space system's instruments do not observe, for example while the body or a mechanism moves. Observations in them are not valid, so point observations, ground tracks (`valid_obs`, and the swaths of `compute_ground_track`), orbit tracks, and ground pixels omit them, and the periods and swaths of region observations end at them. Method `is_observing` of attitudes, schedules, and instruments.
Expand Down
174 changes: 174 additions & 0 deletions docs/validation/earthcare_2026-09-27.3le
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
0 EARTHCARE
1 59908U 24101A 26270.30400445 .00010278 00000+0 14327-3 0 9993
2 59908 97.0025 35.6478 0001699 98.7667 261.3782 15.57094527132456
0 EARTHCARE
1 59908U 24101A 26271.07518142 .00008356 00000+0 11670-3 0 9994
2 59908 97.0027 36.4053 0001679 98.1966 261.9481 15.57106303132571
0 EARTHCARE
1 59908U 24101A 26271.33223884 .00008195 00000+0 11447-3 0 9992
2 59908 97.0029 36.6577 0001670 97.4764 262.6683 15.57111230132617
0 EARTHCARE
1 59908U 24101A 26271.91061552 .00007700 00000+0 10759-3 0 9994
2 59908 97.0028 37.2255 0001677 95.9929 264.1518 15.57120813132700
0 EARTHCARE
1 59908U 24101A 26272.74604323 .00007193 00000+0 10056-3 0 9991
2 59908 97.0027 38.0459 0001695 95.5808 264.5642 15.57132622132833
0 EARTHCARE
1 59908U 24101A 26272.81030651 .00007304 00000+0 10208-3 0 9999
2 59908 97.0028 38.1091 0001699 95.9434 264.2016 15.57133952132840
0 EARTHCARE
1 59908U 24101A 26273.32446627 .00006596 00000+0 92847-4 0 9992
2 59908 97.0028 38.6144 0001623 100.1950 259.9490 15.56981014132928
0 EARTHCARE
1 59908U 24101A 26273.64581377 .00010289 00000+0 14400-3 0 9991
2 59908 97.0029 38.9302 0001593 100.4101 259.7335 15.56988436132971
0 EARTHCARE
1 59908U 24101A 26273.90289106 .00008407 00000+0 11790-3 0 9993
2 59908 97.0027 39.1822 0001724 100.9320 259.2130 15.56991952133014
0 EARTHCARE
1 59908U 24101A 26274.35277531 .00006838 00000+0 96135-4 0 9995
2 59908 97.0026 39.6239 0001772 100.1761 259.9695 15.56996505133083
0 EARTHCARE
1 59908U 24101A 26274.93119503 .00006894 00000+0 96889-4 0 9991
2 59908 97.0025 40.1916 0001792 100.6584 259.4874 15.57004747133174
0 EARTHCARE
1 59908U 24101A 26275.31680633 .00007250 00000+0 10179-3 0 9995
2 59908 97.0024 40.5702 0001778 100.3533 259.7924 15.57010797133233
0 EARTHCARE
1 59908U 24101A 26275.31680634 .00007250 00000+0 10179-3 0 9996
2 59908 97.0024 40.5702 0001778 100.3533 259.7924 15.57010797133233
0 EARTHCARE
1 59908U 24101A 26276.60216813 .00008481 00000+0 11876-3 0 9995
2 59908 97.0023 41.8320 0001794 99.5328 260.6131 15.57030503133431
0 EARTHCARE
1 59908U 24101A 26277.30910986 .00007983 00000+0 11182-3 0 9991
2 59908 97.0022 42.5259 0001763 99.3224 260.8232 15.57040984133548
0 EARTHCARE
1 59908U 24101A 26277.30910987 .00007983 00000+0 11182-3 0 9992
2 59908 97.0022 42.5259 0001763 99.3224 260.8232 15.57040984133548
0 EARTHCARE
1 59908U 24101A 26277.88751157 .00011156 00000+0 15561-3 0 9999
2 59908 97.0022 43.0938 0001756 98.7174 261.4281 15.57056553133637
0 EARTHCARE
1 59908U 24101A 26278.27311009 .00011982 00000+0 16697-3 0 9999
2 59908 97.0022 43.4723 0001744 98.8004 261.3449 15.57065480133693
0 EARTHCARE
1 59908U 24101A 26278.59444088 .00010580 00000+0 14757-3 0 9996
2 59908 97.0022 43.7878 0001755 98.7646 261.3809 15.57069955133747
0 EARTHCARE
1 59908U 24101A 26278.91576980 .00010295 00000+0 14361-3 0 9993
2 59908 97.0022 44.1033 0001756 98.5106 261.6349 15.57077111133795
0 EARTHCARE
1 59908U 24101A 26279.10856661 .00010090 00000+0 14075-3 0 9997
2 59908 97.0023 44.2926 0001760 98.4262 261.7194 15.57080861133824
0 EARTHCARE
1 59908U 24101A 26279.30136280 .00010068 00000+0 14042-3 0 9996
2 59908 97.0023 44.4819 0001749 97.9664 262.1791 15.57085415133855
0 EARTHCARE
1 59908U 24101A 26279.62268893 .00009308 00000+0 12991-3 0 9993
2 59908 97.0025 44.7975 0001764 97.5609 262.5847 15.57091013133908
0 EARTHCARE
1 59908U 24101A 26279.81548394 .00009281 00000+0 12952-3 0 9998
2 59908 97.0025 44.9868 0001768 97.7061 262.4396 15.57095177133935
0 EARTHCARE
1 59908U 24101A 26280.32963292 .00008649 00000+0 12114-3 0 9991
2 59908 97.0027 45.4920 0002301 120.0967 240.0518 15.57015634134019
0 EARTHCARE
1 59908U 24101A 26280.90804579 .00007673 00000+0 10760-3 0 9998
2 59908 97.0027 46.0596 0002057 114.3505 245.7966 15.57023889134107
0 EARTHCARE
1 59908U 24101A 26281.61498963 .00009849 00000+0 13764-3 0 9997
2 59908 97.0030 46.7538 0001908 107.8974 252.2491 15.57038973134213
0 EARTHCARE
1 59908U 24101A 26281.80779139 .00010110 00000+0 14122-3 0 9997
2 59908 97.0031 46.9431 0001911 107.6651 252.4814 15.57043065134244
0 EARTHCARE
1 59908U 24101A 26282.77179213 .00011580 00000+0 16142-3 0 9997
2 59908 97.0035 47.8899 0001938 107.3306 252.8162 15.57064219134399
0 EARTHCARE
1 59908U 24101A 26282.90032570 .00010620 00000+0 14816-3 0 9996
2 59908 97.0035 48.0162 0001928 107.1180 253.0287 15.57064131134419
0 EARTHCARE
1 59908U 24101A 26283.92858931 .00010396 00000+0 14501-3 0 9997
2 59908 97.0042 49.0266 0001964 107.0799 253.0672 15.57074560134570
0 EARTHCARE
1 59908U 24101A 26284.24992114 .00008781 00000+0 12275-3 0 9996
2 59908 97.0056 49.3428 0001125 121.7230 238.4136 15.57067307134629
0 EARTHCARE
1 59908U 24101A 26285.92080361 .00003903 00000+0 55204-4 0 9995
2 59908 97.0047 50.9835 0002068 105.6429 254.5055 15.57115154134888
0 EARTHCARE
1 59908U 24101A 26287.59173376 .00003559 00000+0 50722-4 0 9996
2 59908 97.0048 52.6243 0001791 98.3036 261.8424 15.56971239135149
0 EARTHCARE
1 59908U 24101A 26287.91308245 .00003560 00000+0 50729-4 0 9996
2 59908 97.0045 52.9401 0002233 96.7262 263.4249 15.56977907135196
0 EARTHCARE
1 59908U 24101A 26290.93367580 .00003625 00000+0 51486-4 0 9992
2 59908 97.0026 55.9065 0001923 96.3252 263.8223 15.57055294135669
0 EARTHCARE
1 59908U 24101A 26290.93367581 .00003625 00000+0 51486-4 0 9993
2 59908 97.0026 55.9065 0001924 96.3252 263.8223 15.57055294135660
0 EARTHCARE
1 59908U 24101A 26291.76913756 .00003546 00000+0 50367-4 0 9995
2 59908 97.0058 56.7272 0001742 88.4867 271.6589 15.57066367135795
0 EARTHCARE
1 59908U 24101A 26291.76913756 .00003546 00000+0 50367-4 0 9995
2 59908 97.0058 56.7272 0001742 88.4867 271.6588 15.57066367135794
0 EARTHCARE
1 59908U 24101A 26292.79737737 .00003751 00000+0 53146-4 0 9998
2 59908 96.9992 57.7376 0001506 99.2907 260.8520 15.57095573135953
0 EARTHCARE
1 59908U 24101A 26292.79737738 .00003751 00000+0 53146-4 0 9999
2 59908 96.9992 57.7376 0001506 99.2907 260.8520 15.57095573135953
0 EARTHCARE
1 59908U 24101A 26293.82560905 .00003749 00000+0 53103-4 0 9994
2 59908 97.0045 58.7474 0000880 120.8749 239.2594 15.57104807136114
0 EARTHCARE
1 59908U 24101A 26297.81024450 .00002604 00000+0 37350-4 0 9992
2 59908 97.0063 62.6593 0001915 90.1833 269.9642 15.57054905136738
0 EARTHCARE
1 59908U 24101A 26299.86674944 .00002325 00000+0 33445-4 0 9999
2 59908 97.0072 64.6820 0002042 94.8464 265.3025 15.57086876137059
0 EARTHCARE
1 59908U 24101A 26301.60193994 .00002399 00000+0 34558-4 0 9993
2 59908 97.0061 66.3859 0001907 110.0112 250.1350 15.57020012137321
0 EARTHCARE
1 59908U 24101A 26301.79474373 .00002373 00000+0 34191-4 0 9991
2 59908 97.0053 66.5747 0002047 110.0831 250.0646 15.57022240137359
0 EARTHCARE
1 59908U 24101A 26302.63022384 .00002548 00000+0 36603-4 0 9990
2 59908 97.0062 67.3969 0002119 103.9145 256.2347 15.57030080137484
0 EARTHCARE
1 59908U 24101A 26305.32939785 .00003175 00000+0 45205-4 0 9996
2 59908 97.0059 70.0466 0001929 90.4463 269.7015 15.57087475137902
0 EARTHCARE
1 59908U 24101A 26305.32939785 .00003175 00000+0 45205-4 0 9996
2 59908 97.0059 70.0466 0001929 90.4463 269.7015 15.57087475137902
0 EARTHCARE
1 59908U 24101A 26307.32159083 .00002642 00000+0 37777-4 0 9996
2 59908 97.0056 72.0051 0001923 100.9333 259.2139 15.57124313138217
0 EARTHCARE
1 59908U 24101A 26307.32159084 .00002642 00000+0 37777-4 0 9997
2 59908 97.0056 72.0051 0001923 100.9333 259.2139 15.57124313138217
0 EARTHCARE
1 59908U 24101A 26309.18532497 .00002966 00000+0 42291-4 0 9992
2 59908 97.0270 73.8709 0009943 329.3908 30.6767 15.57065875138506
0 EARTHCARE
1 59908U 24101A 26309.31388748 .00002986 00000+0 42718-4 0 9991
2 59908 97.0068 73.9652 0001671 77.6970 282.4473 15.57004533138528
0 EARTHCARE
1 59908U 24101A 26309.31388748 .00002986 00000+0 42718-4 0 9991
2 59908 97.0068 73.9652 0001671 77.6970 282.4473 15.57004533138528
0 EARTHCARE
1 59908U 24101A 26310.59924290 .00003558 00000+0 50578-4 0 9990
2 59908 97.0059 75.2257 0002750 96.9250 263.2319 15.57040707138729
0 EARTHCARE
1 59908U 24101A 26311.30617853 .00004223 00000+0 59757-4 0 9992
2 59908 97.0084 75.9264 0002209 67.3764 292.7725 15.57053133138830
0 EARTHCARE
1 59908U 24101A 26311.62750801 .00004461 00000+0 63043-4 0 9995
2 59908 97.0160 76.2389 0000978 99.6583 260.4783 15.57061660138880
0 EARTHCARE
1 59908U 24101A 26311.62750802 .00004461 00000+0 63043-4 0 9996
2 59908 97.0160 76.2389 0000978 99.6583 260.4783 15.57061661138881
Loading
Loading