satpy.readers.nucaps module

Interface to NUCAPS Retrieval NetCDF files.

NUCAPS stands for NOAA Unique Combined Atmospheric Processing System. NUCAPS retrievals include temperature, moisture, trace gas, and cloud-cleared radiance profiles. Product details can be found at:

This reader supports both standard NOAA NUCAPS EDRs, and Science EDRs, which are essentially a subset of the standard EDRs with some additional parameters such as relative humidity and boundary layer temperature.

NUCAPS data is derived from Cross-track Infrared Sounder (CrIS) data, and from Advanced Technology Microwave Sounder (ATMS) data, instruments onboard Joint Polar Satellite System spacecraft.

class satpy.readers.nucaps.NUCAPSFileHandler(*args, **kwargs)[source]

Bases: NetCDF4FileHandler

File handler for NUCAPS netCDF4 format.

Initialize file handler.


Parse NUCAPS datetime string.

property end_orbit_number

Return orbit number for the end of the swath.

property end_time

Get end time.

get_dataset(dataset_id, ds_info)[source]

Load data array and metadata for specified dataset.

get_metadata(dataset_id, ds_info)[source]

Get metadata.

get_shape(ds_id, ds_info)[source]

Return data array shape for item specified.

property platform_name

Return standard platform name for the file’s data.

property sensor_names

Return standard sensor or instrument name for the file’s data.

property start_orbit_number

Return orbit number for the beginning of the swath.

property start_time

Get start time.

class satpy.readers.nucaps.NUCAPSReader(config_files, mask_surface=True, mask_quality=True, **kwargs)[source]

Bases: FileYAMLReader

Reader for NUCAPS NetCDF4 files.

Configure reader behavior.

  • mask_surface (boolean) – mask anything below the surface pressure

  • mask_quality (boolean) – mask anything where the Quality_Flag metadata is != 1.

_abc_impl = <_abc._abc_data object>
_filter_dataset_keys_outside_pressure_levels(dataset_keys, pressure_levels)[source]
load(dataset_keys, previous_datasets=None, pressure_levels=None)[source]

Load data from one or more set of files.


pressure_levels – mask out certain pressure levels: True for all levels (min, max) for a range of pressure levels […] list of levels to include


Convert config dataset entries to DataIDs.

Special handling is done to provide level specific datasets for any pressured based datasets. For example, a dataset is added for each pressure level of ‘Temperature’ with each new dataset being named ‘Temperature_Xmb’ where X is the pressure level.

satpy.readers.nucaps._get_pressure_level_condition(plevels_ds, pressure_levels)[source]
satpy.readers.nucaps._mask_data_below_surface_pressure(datasets_loaded, dataset_keys)[source]
satpy.readers.nucaps._mask_data_with_quality_flag(datasets_loaded, dataset_keys)[source]
satpy.readers.nucaps._remove_data_at_pressure_levels(datasets_loaded, plevels_ds, pressure_levels)[source]