Add HIRS documentation and tests.

Author: lupemba

docs/src/ATOVS.md

@@ -58,7 +58,56 @@ end
 The plot shows the radiance for the AMSU-A channel 2 (31.4 GHz) observed during an orbit.
 
 ## HIRS
-To be done
+The High Resolution Infrared Sounder (HIRS) is an instrument on the METOP satellites. It is a 20 channel infrared sounder and one of the three Advanced TIROS Operational Sounder (ATOVS) sensors. 
+
+The level 1B HIRS files contain the radiance of the 19 channels and the reflectance for channel 20.  See the [HIRS Level 1B product page](https://data.eumetsat.int/product/EO:EUM:DAT:MULT:HIRSL1) for more information.  
+This example shows how we plot the radiance from channel 7 on a map.
+
+This example is made using the following packages.
+```
+[13f3f980] CairoMakie v0.15.6
+[db073c08] GeoMakie v0.7.15
+```
+
+```julia
+using MetopDatasets
+using CairoMakie, GeoMakie, Statistics
+
+# Open the dataset.
+path = "HIRS_xxx_1B_M01_20160720074253Z_20160720092153Z_N_O_20160720083048Z.nat"
+ds = MetopDataset(path, maskingvalue=NaN);
+
+# read location
+latitude = ds["earth_location"][1,:,:]
+longitude = ds["earth_location"][2,:,:]
+
+# read radiance
+radiance_of_band = ds["digital_a_rad"][7,:,:] # Channel 7
+
+radiance_q05 = quantile(radiance_of_band[.!isnan.(radiance_of_band)],0.05)
+radiance_q95 = quantile(radiance_of_band[.!isnan.(radiance_of_band)],0.95)
+
+fig = let
+    # Create figure and axis
+    fig = Figure()
+    ax = GeoAxis(fig[1, 1],
+        title = "HIRS Channel 7",
+        xlabel = "longitude",
+        ylabel = "latitude")
+
+    # plot data with color map
+        scatter!(ax, longitude[:], latitude[:],
+        color = radiance_of_band[:], colorrange = (radiance_q05,radiance_q95), markersize = 2)
+
+    # Add colorbar
+    Colorbar(fig[1,2], colorrange = (radiance_q05,radiance_q95))
+
+    # Add coastlines
+    lines!(ax, GeoMakie.coastlines()) 
+    fig
+end
+```
+![HIRS channel 7](HIRS_plot.png)
 
 ## MHS
 The Microwave Humidity Sounder (MHS) is an instrument on the METOP satellites. It measures the earth using 5 microwave channels sensitive to surface temperatures, emissivities, and atmospheric humidity. MHS is one of the three Advanced TIROS Operational Sounder (ATOVS) sensors.

docs/src/HIRS_plot.png

@@ -339,23 +339,27 @@ end
 ```
 
 ## Supported formats
+- AMSU-A Level 1B
 - ASCAT Level 1B
 - ASCAT Level 2 Soil Moisture
+- HIRS Level 1B
 - IASI Level 1C
 - IASI Level 2 Combined Sounding
 - MHS Level 1B 
 
 ### Formats not yet supported
-- AMSU-A Level 1B
 - AVHRR Level 1B
 - GOME-2 Level 1B
-- HIRS Level 1B 
+- IASI Level 1C Principal Component Scores
 
 ### Reference documents 
 - [EPS Generic Product Format Specification](https://user.eumetsat.int/s3/eup-strapi-media/pdf_gen_pfs_13e3f0feb7.pdf)
+- [AMSU-A Level 1 Product Format Specification](https://user.eumetsat.int/s3/eup-strapi-media/pdf_amsu_a_l1_pfs_c89fa9d9ea.pdf)
 - [ASCAT Level 1: Product Format Specification](https://user.eumetsat.int/s3/eup-strapi-media/ASCAT_Level_1_Product_Format_V12_Annexe_50fe72d349.pdf)
 - [ASCAT Level 2 Soil Moisture: Product Format Specification](https://user.eumetsat.int/s3/eup-strapi-media/pdf_ten_0343_eps_ascatl2_pfs_f509981295.pdf)
+- [HIRS Level 1 Product Format Specification](https://user.eumetsat.int/s3/eup-strapi-media/pdf_ten_97230_eps_hirs4l1_pfs_0ddaefcb74.pdf)
 - [IASI Level 1 Product Format Specification](https://user.eumetsat.int/s3/eup-strapi-media/pdf_iasi_level_1_pfs_2105bc9ccf.pdf)
+- [IASI Level 2: Product Format Specification](https://user.eumetsat.int/s3/eup-strapi-media/pdf_ten_980760_eps_iasi_l2_f9511c26d2.pdf)
 - [MHS Level 1 Product Format Specification](https://user.eumetsat.int/s3/eup-strapi-media/pdf_ten_97229_eps_mhs_pfs_2069b45efc.pdf)
 
 

docs/src/index.md

@@ -1,3 +1,6 @@
+# Copyright (c) 2025 EUMETSAT
+# License: MIT
+
 using MetopDatasets, Test
 using Dates
 

test/AMSU_A.jl

@@ -0,0 +1,29 @@
+# Copyright (c) 2025 EUMETSAT
+# License: MIT
+
+using MetopDatasets, Test
+using Dates
+
+test_data_artifact = MetopDatasets.get_test_data_artifact()
+
+HIRS_test_file = joinpath(
+    test_data_artifact, "HIRS_xxx_1B_M01_20241104213353Z_cropped_10.nat")
+
+@testset "HIRS record type" begin
+    @test MetopDatasets.native_sizeof(MetopDatasets.HIRS_XXX_1B_V10) == 6884
+    @test MetopDatasets.fixed_size(MetopDatasets.HIRS_XXX_1B_V10)
+    @test MetopDatasets.HIRS_XXX_1B_V10 <: MetopDatasets.ATOVS_1B
+end
+
+@testset "HIRS dataset" begin
+    ds = MetopDataset(HIRS_test_file)
+
+    @test all(-90 .< ds["earth_location"][1, :, :] .< 90)
+    @test all(-180 .< ds["earth_location"][2, :, :] .< 180)
+
+    @test "digital_a_rad" in keys(ds)
+    @test "digital_a_rad_header" in keys(ds)
+    
+    @test size(ds["digital_a_rad"]) == (20, 56, 10)
+    @test size(ds["digital_a_rad_header"]) == (56, 10)
+end

test/HIRS.jl

@@ -36,6 +36,10 @@ end
     include("AMSU_A.jl")
 end
 
+@safetestset "HIRS" begin
+    include("HIRS.jl")
+end
+
 @safetestset "Main product header" begin
     include("main_product_header.jl")
 end
@@ -52,8 +56,6 @@ end
     include("conversions.jl")
 end
 
-Aqua.test_all(MetopDatasets)
-
 @safetestset "Extended tests" begin
     if isdir("testData")
         @info "Running extended tests"
@@ -62,3 +64,5 @@ Aqua.test_all(MetopDatasets)
         @info "Skipping extended tests"
     end
 end
+
+Aqua.test_all(MetopDatasets)