Add support for changes in S5P NL-L2 02.07.01 processor outputs

- add snow/ice variables for AAI, CH4, and CO products - add support for 'corrected' option to 'ch4' ingestion option which will ingest the destripe corrected CH4 column Also fixed an issue where the SWIR/NIR selection of the surface albedo for CH4 was incorrectly switching based on the 'ch4' ingestion option instead of the 'band' ingestion option
stcorp · Sep 12, 2024 · b8be29b · b8be29b
1 parent 7dedb0c
commit b8be29b
Show file tree

Hide file tree

Showing 5 changed files with 196 additions and 24 deletions.
diff --git a/CHANGES b/CHANGES
@@ -4,6 +4,9 @@
 * Updates to product ingestions:
   - GOME-2 L2: added support for O3MARS aerosol layer height and added
     support for O3MARP V5
+  - S5P L2: added snow_ice_type/sea_ice_fraction ingestion for AAI/CO/CH4
+  - S5P L2 CH4: added 'corrected' option to ingest destriped columns and
+    fixed issue in NIR/SWIR selection of surface albedo
   - S5P PAL L2: added support for SRON/SICOR HDO (L2__HDO__S) product
 
 1.23 2024-07-30

diff --git a/doc/html/ingestions/S5P_L2_AER_AI.html b/doc/html/ingestions/S5P_L2_AER_AI.html
@@ -241,6 +241,18 @@ <h2>Variables</h2>
 <td></td>
 <td><p>continuous quality descriptor, varying between 0 (no data) and 100 (full quality data)</p></td>
 </tr>
+<tr class="row-even"><td><p><strong>snow_ice_type</strong></p></td>
+<td><p>int8</p></td>
+<td><p>{<em>time</em>}</p></td>
+<td></td>
+<td><p>surface snow/ice type; enumeration values: snow_free_land (0), sea_ice (1), permanent_ice (2), snow (3), ocean (4)</p></td>
+</tr>
+<tr class="row-odd"><td><p><strong>sea_ice_fraction</strong></p></td>
+<td><p>float</p></td>
+<td><p>{<em>time</em>}</p></td>
+<td><p>[]</p></td>
+<td><p>sea-ice concentration (as a fraction)</p></td>
+</tr>
 <tr class="row-even"><td><p><strong>index</strong></p></td>
 <td><p>int32</p></td>
 <td><p>{<em>time</em>}</p></td>
@@ -439,6 +451,32 @@ <h2>Mapping description</h2>
 <td><p><em>path</em></p></td>
 <td><p><strong>/PRODUCT/qa_value</strong></p></td>
 </tr>
+<tr class="row-even"><td rowspan="4"><p><strong>snow_ice_type</strong></p></td>
+<td><p><em>available</em></p></td>
+<td><p>optional</p></td>
+</tr>
+<tr class="row-odd"><td><p><em>condition</em></p></td>
+<td><p>processor version &gt;= 02.07.00</p></td>
+</tr>
+<tr class="row-even"><td><p><em>path</em></p></td>
+<td><p><strong>/PRODUCT/SUPPORT_DATA/INPUT_DATA/snow_ice_flag[]</strong></p></td>
+</tr>
+<tr class="row-odd"><td><p><em>description</em></p></td>
+<td><p>0: snow_free_land (0), 1-100: sea_ice (1), 101: permanent_ice (2), 103: snow (3), 255: ocean (4), other values map to -1</p></td>
+</tr>
+<tr class="row-even"><td rowspan="4"><p><strong>sea_ice_fraction</strong></p></td>
+<td><p><em>available</em></p></td>
+<td><p>optional</p></td>
+</tr>
+<tr class="row-odd"><td><p><em>condition</em></p></td>
+<td><p>processor version &gt;= 02.07.00</p></td>
+</tr>
+<tr class="row-even"><td><p><em>path</em></p></td>
+<td><p><strong>/PRODUCT/SUPPORT_DATA/INPUT_DATA/snow_ice_flag[]</strong></p></td>
+</tr>
+<tr class="row-odd"><td><p><em>description</em></p></td>
+<td><p>if 1 &lt;= snow_ice_flag &lt;= 100 then snow_ice_flag/100.0 else 0.0</p></td>
+</tr>
 </tbody>
 </table>
 </section>

diff --git a/doc/html/ingestions/S5P_L2_CH4.html b/doc/html/ingestions/S5P_L2_CH4.html
@@ -313,6 +313,18 @@ <h2>Variables</h2>
 <td><p>[]</p></td>
 <td><p>precision of the surface albedo</p></td>
 </tr>
+<tr class="row-even"><td><p><strong>snow_ice_type</strong></p></td>
+<td><p>int8</p></td>
+<td><p>{<em>time</em>}</p></td>
+<td></td>
+<td><p>surface snow/ice type; enumeration values: snow_free_land (0), sea_ice (1), permanent_ice (2), snow (3), ocean (4)</p></td>
+</tr>
+<tr class="row-odd"><td><p><strong>sea_ice_fraction</strong></p></td>
+<td><p>float</p></td>
+<td><p>{<em>time</em>}</p></td>
+<td><p>[]</p></td>
+<td><p>sea-ice concentration (as a fraction)</p></td>
+</tr>
 <tr class="row-even"><td><p><strong>index</strong></p></td>
 <td><p>int32</p></td>
 <td><p>{<em>time</em>}</p></td>
@@ -339,8 +351,8 @@ <h2>Ingestion options</h2>
 </thead>
 <tbody>
 <tr class="row-even"><td><p>ch4</p></td>
-<td><p>bias_corrected</p></td>
-<td><p>whether to ingest the ‘normal’ CH4 column vmr (default) or the bias corrected CH4 column vmr (ch4=bias_corrected)</p></td>
+<td><p>bias_corrected, corrected</p></td>
+<td><p>whether to ingest the ‘normal’ CH4 column vmr (default) or the bias corrected CH4 column vmr (ch4=bias_corrected), or the bias corrected and destriping corrected CH4 column vmr (ch4=corrected)</p></td>
 </tr>
 <tr class="row-odd"><td><p>band</p></td>
 <td><p>NIR</p></td>
@@ -499,7 +511,7 @@ <h2>Mapping description</h2>
 <tr class="row-even"><td><p><em>path</em></p></td>
 <td><p><strong>/PRODUCT/SUPPORT_DATA/INPUT_DATA/eastward_wind[]</strong></p></td>
 </tr>
-<tr class="row-odd"><td rowspan="4"><p><strong>CH4_column_volume_mixing_ratio_dry_air</strong></p></td>
+<tr class="row-odd"><td rowspan="6"><p><strong>CH4_column_volume_mixing_ratio_dry_air</strong></p></td>
 <td><p><em>condition</em></p></td>
 <td><p>ch4 unset</p></td>
 </tr>
@@ -512,6 +524,12 @@ <h2>Mapping description</h2>
 <tr class="row-even"><td><p><em>path</em></p></td>
 <td><p><strong>/PRODUCT/methane_mixing_ratio_bias_corrected[]</strong></p></td>
 </tr>
+<tr class="row-odd"><td><p><em>condition</em></p></td>
+<td><p>ch4=corrected and processor version &gt;= 02.07.00</p></td>
+</tr>
+<tr class="row-even"><td><p><em>path</em></p></td>
+<td><p><strong>/PRODUCT/methane_mixing_ratio_bias_corrected_destriped[]</strong></p></td>
+</tr>
 <tr class="row-odd"><td><p><strong>CH4_column_volume_mixing_ratio_dry_air_uncertainty</strong></p></td>
 <td><p><em>path</em></p></td>
 <td><p><strong>/PRODUCT/methane_mixing_ratio_precision[]</strong></p></td>
@@ -614,6 +632,32 @@ <h2>Mapping description</h2>
 <tr class="row-even"><td><p><em>path</em></p></td>
 <td><p><strong>/PRODUCT/SUPPORT_DATA/DETAILED_RESULTS/surface_albedo_SWIR_precision[]</strong></p></td>
 </tr>
+<tr class="row-odd"><td rowspan="4"><p><strong>snow_ice_type</strong></p></td>
+<td><p><em>available</em></p></td>
+<td><p>optional</p></td>
+</tr>
+<tr class="row-even"><td><p><em>condition</em></p></td>
+<td><p>processor version &gt;= 02.07.00</p></td>
+</tr>
+<tr class="row-odd"><td><p><em>path</em></p></td>
+<td><p><strong>/PRODUCT/SUPPORT_DATA/INPUT_DATA/snow_ice_flag[]</strong></p></td>
+</tr>
+<tr class="row-even"><td><p><em>description</em></p></td>
+<td><p>0: snow_free_land (0), 1-100: sea_ice (1), 101: permanent_ice (2), 103: snow (3), 255: ocean (4), other values map to -1</p></td>
+</tr>
+<tr class="row-odd"><td rowspan="4"><p><strong>sea_ice_fraction</strong></p></td>
+<td><p><em>available</em></p></td>
+<td><p>optional</p></td>
+</tr>
+<tr class="row-even"><td><p><em>condition</em></p></td>
+<td><p>processor version &gt;= 02.07.00</p></td>
+</tr>
+<tr class="row-odd"><td><p><em>path</em></p></td>
+<td><p><strong>/PRODUCT/SUPPORT_DATA/INPUT_DATA/snow_ice_flag[]</strong></p></td>
+</tr>
+<tr class="row-even"><td><p><em>description</em></p></td>
+<td><p>if 1 &lt;= snow_ice_flag &lt;= 100 then snow_ice_flag/100.0 else 0.0</p></td>
+</tr>
 </tbody>
 </table>
 </section>

diff --git a/doc/html/ingestions/S5P_L2_CO.html b/doc/html/ingestions/S5P_L2_CO.html
@@ -295,6 +295,18 @@ <h2>Variables</h2>
 <td><p>[]</p></td>
 <td><p>Scattering optical thickness SWIR</p></td>
 </tr>
+<tr class="row-odd"><td><p><strong>snow_ice_type</strong></p></td>
+<td><p>int8</p></td>
+<td><p>{<em>time</em>}</p></td>
+<td></td>
+<td><p>surface snow/ice type; enumeration values: snow_free_land (0), sea_ice (1), permanent_ice (2), snow (3), ocean (4)</p></td>
+</tr>
+<tr class="row-even"><td><p><strong>sea_ice_fraction</strong></p></td>
+<td><p>float</p></td>
+<td><p>{<em>time</em>}</p></td>
+<td><p>[]</p></td>
+<td><p>sea-ice concentration (as a fraction)</p></td>
+</tr>
 <tr class="row-odd"><td><p><strong>index</strong></p></td>
 <td><p>int32</p></td>
 <td><p>{<em>time</em>}</p></td>
@@ -563,6 +575,32 @@ <h2>Mapping description</h2>
 <td><p><em>path</em></p></td>
 <td><p><strong>/PRODUCT/SUPPORT_DATA/DETAILED_RESULTS/scattering_optical_thickness_SWIR[]</strong></p></td>
 </tr>
+<tr class="row-odd"><td rowspan="4"><p><strong>snow_ice_type</strong></p></td>
+<td><p><em>available</em></p></td>
+<td><p>optional</p></td>
+</tr>
+<tr class="row-even"><td><p><em>condition</em></p></td>
+<td><p>processor version &gt;= 02.07.00</p></td>
+</tr>
+<tr class="row-odd"><td><p><em>path</em></p></td>
+<td><p><strong>/PRODUCT/SUPPORT_DATA/INPUT_DATA/snow_ice_flag[]</strong></p></td>
+</tr>
+<tr class="row-even"><td><p><em>description</em></p></td>
+<td><p>0: snow_free_land (0), 1-100: sea_ice (1), 101: permanent_ice (2), 103: snow (3), 255: ocean (4), other values map to -1</p></td>
+</tr>
+<tr class="row-odd"><td rowspan="4"><p><strong>sea_ice_fraction</strong></p></td>
+<td><p><em>available</em></p></td>
+<td><p>optional</p></td>
+</tr>
+<tr class="row-even"><td><p><em>condition</em></p></td>
+<td><p>processor version &gt;= 02.07.00</p></td>
+</tr>
+<tr class="row-odd"><td><p><em>path</em></p></td>
+<td><p><strong>/PRODUCT/SUPPORT_DATA/INPUT_DATA/snow_ice_flag[]</strong></p></td>
+</tr>
+<tr class="row-even"><td><p><em>description</em></p></td>
+<td><p>if 1 &lt;= snow_ice_flag &lt;= 100 then snow_ice_flag/100.0 else 0.0</p></td>
+</tr>
 </tbody>
 </table>
 </section>