Skip to content

Commit

Permalink
Update viirs_edr module docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
djhoese committed Jul 26, 2023
1 parent c0b6e83 commit 31988b6
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions satpy/readers/viirs_edr.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) 2022 Satpy developers
# Copyright (c) 2022-2023 Satpy developers
#
# This file is part of satpy.
#
Expand All @@ -15,30 +15,35 @@
#
# You should have received a copy of the GNU General Public License along with
# satpy. If not, see <http://www.gnu.org/licenses/>.
"""VIIRS NOAA enterprise L2 product reader.
"""VIIRS NOAA enterprise EDR product reader.
This module defines the :class:`VIIRSJRRFileHandler` file handler, to
be used for reading VIIRS Level 2 products generated by the NOAA enterprise
suite, which are downloadable via NOAA CLASS.
A wide variety of such products exist and, at present, only three are
supported here, showing example filenames:
be used for reading VIIRS EDR products generated by the NOAA enterprise
suite, which are downloadable via NOAA CLASS or on NOAA's AWS buckets.
A wide variety of such products exist and, at present, only a subset are supported.
- Cloud mask: JRR-CloudMask_v2r3_j01_s202112250807275_e202112250808520_c202112250837300.nc
- Aerosol properties: JRR-ADP_v2r3_j01_s202112250807275_e202112250808520_c202112250839550.nc
- Cloud products: JRR-CloudHeight_v2r3_j01_s202112250807275_e202112250808520_c202112250837300.nc
- Aerosol detection: JRR-ADP_v2r3_j01_s202112250807275_e202112250808520_c202112250839550.nc
- Aerosol optical depth: JRR-AOD_v2r3_j01_s202112250807275_e202112250808520_c202112250839550.nc
- Surface reflectance: SurfRefl_v1r1_j01_s202112250807275_e202112250808520_c202112250845080.nc
All products use the same base reader `viirs_l2_jrr` and can be read through satpy with::
All products use the same base reader ``viirs_edr`` and can be read through satpy with::
import satpy
import glob
filenames = glob.glob('JRR-ADP*.nc')
scene = satpy.Scene(filenames,
reader='viirs_l2_jrr')
scene = satpy.Scene(filenames, reader='viirs_edr')
scene.load(['smoke_concentration'])
NOTE:
Multiple products contain datasets with the same name! For example, both the cloud mask
and aerosol files contain a cloud mask, but these are not identical.
For clarity, the aerosol file cloudmask is named `cloud_mask_adp` in this reader.
.. note::
Multiple products contain datasets with the same name! For example, both the cloud mask
and aerosol detection files contain a cloud mask, but these are not identical.
For clarity, the aerosol file cloudmask is named `cloud_mask_adp` in this reader.
"""


Expand Down

0 comments on commit 31988b6

Please sign in to comment.