Satpy’s Documentation

Satpy is a python library for reading, manipulating, and writing data from remote-sensing earth-observing satellite instruments. Satpy provides users with readers that convert geophysical parameters from various file formats to the common Xarray DataArray and Dataset classes for easier interoperability with other scientific python libraries. Satpy also provides interfaces for creating RGB (Red/Green/Blue) images and other composite types by combining data from multiple instrument bands or products. Various atmospheric corrections and visual enhancements are provided for improving the usefulness and quality of output images. Output data can be written to multiple output file formats such as PNG, GeoTIFF, and CF standard NetCDF files. Satpy also allows users to resample data to geographic projected grids (areas). Satpy is maintained by the open source Pytroll group.

The Satpy library acts as a high-level abstraction layer on top of other libraries maintained by the Pytroll group including:

• pyresample

• pyspectral

• trollimage

• pycoast

• pydecorate

• python-geotiepoints

• pyninjotiff

Go to the Satpy project page for source code and downloads.

Satpy is designed to be easily extendable to support any earth observation satellite by the creation of plugins (readers, compositors, writers, etc). The table at the bottom of this page shows the input formats supported by the base Satpy installation.

Note

Satpy’s interfaces are not guaranteed stable and may change until version 1.0 when backwards compatibility will be a main focus.

Getting Help

Having trouble installing or using Satpy? Feel free to ask questions at any of the contact methods for the PyTroll group here or file an issue on Satpy’s GitHub page.

Documentation

• Overview
  • Scene
  • DataArrays
  • Reading
  • Compositing
  • Resampling
  • Enhancements
  • Writing
• Installation Instructions
  • Conda-based Installation
  • Pip-based Installation
  • Ubuntu System Python Installation
• Configuration
  • Settings
  • Component Configuration
• Downloading Data
  • NOAA GOES on Amazon Web Services
  • NOAA GOES on Google Cloud Platform
  • NOAA CLASS
  • NASA VIIRS Atmosphere SIPS
  • EUMETSAT Data Center
• Examples
• Quickstart
  • Loading and accessing data
  • Calculating measurement values and navigation coordinates
  • Visualizing data
  • Creating new datasets
  • Generating composites
  • Resampling
  • Saving to disk
  • Slicing and subsetting scenes
  • Troubleshooting
• Readers
  • Available Readers
  • Filter loaded files
  • Load data
  • Load remote data
  • Search for local/remote files
  • Metadata
  • Coordinates
  • Adding a Reader to Satpy
  • Implemented readers
• Reading remote files
  • Using a single reader
  • Using multiple readers
  • Caching the remote files
  • Resources
• Composites
  • Built-in Compositors
  • Creating composite configuration files
  • Enhancing the images
  • Modifiers
• Resampling
  • Resampling algorithms
  • Resampling for comparison and composites
  • Caching for geostationary data
  • Create custom area definition
  • Create dynamic area definition
  • Store area definitions
• Enhancements
  • Built-in enhancement methods
• Writers
  • Available Writers
  • Colorizing and Palettizing using user-supplied colormaps
  • Saving multiple Scenes in one go
• MultiScene (Experimental)
  • MultiScene Creation
  • Blending Scenes in MultiScene
  • Saving frames of an animation
  • Saving multiple scenes
  • Combining multiple readers
• Developer’s Guide
  • How to contribute
  • Migrating to xarray and dask
  • Adding a Custom Reader to Satpy
  • Adding remote file support to a reader
  • Extending Satpy via plugins
  • Satpy internal workings: having a look under the hood
  • Auxiliary Data Download
  • Writing unit tests
  • Coding guidelines
  • Development installation
  • Running tests
  • Running benchmarks
  • Documentation

• Satpy API
• FAQ
• Release Notes
• Security Policy

Satpy Readers

Description	Reader name	Status	fsspec support
GOES-R ABI imager Level 1b data in netcdf format	abi_l1b	Nominal	true
SCMI ABI L1B in netCDF4 format	abi_l1b_scmi	Beta	false
GOES-R ABI Level 2 products in netCDF4 format	abi_l2_nc	Beta	true
NOAA Level 2 ACSPO SST data in netCDF4 format	acspo	Nominal	false
FY-4A AGRI L1 data in HDF5 format	agri_fy4a_l1	Beta	false
	agri_fy4b_l1		false
Himawari (8 + 9) AHI Level 1 (HRIT)	ahi_hrit	Nominal	false
Himawari (8 + 9) AHI Level 1b (HSD)	ahi_hsd	Nominal	false
Himawari (8 + 9) AHI Level 1b (gridded)	ahi_l1b_gridded_bin	Nominal	false
GEO-KOMPSAT-2 AMI Level 1b	ami_l1b	Beta	false
GCOM-W1 AMSR2 data in HDF5 format	amsr2_l1b	Nominal	false
GCOM-W1 AMSR2 Level 2 (HDF5)	amsr2_l2	Beta	false
GCOM-W1 AMSR2 Level 2 GAASP (NetCDF4)	amsr2_l2_gaasp	Beta	false
AAPP L1C AMSU-B format	amsub_l1c_aapp	Beta	false
METOP ASCAT Level 2 SOILMOISTURE BUFR	ascat_l2_soilmoisture_bufr	Defunct	false
S-NPP and JPSS-1 ATMS L1B (NetCDF4)	atms_l1b_nc	Beta	false
S-NPP and JPSS ATMS SDR (hdf5)	atms_sdr_hdf5	Beta	false
NOAA 15 to 19, Metop A to C AVHRR data in AAPP format	avhrr_l1b_aapp	Nominal	false
Metop A to C AVHRR in native level 1 format	avhrr_l1b_eps	Nominal	false
Tiros-N, NOAA 7 to 19 AVHRR data in GAC and LAC format	avhrr_l1b_gaclac	Nominal	false
NOAA 15 to 19 AVHRR data in raw HRPT format	avhrr_l1b_hrpt	Alpha	false
EUMETCSAT GAC FDR NetCDF4	avhrr_l1c_eum_gac_fdr_nc	Defunct	false
Callipso Caliop Level 2 Cloud Layer data (v3) in EOS-hdf4 format	caliop_l2_cloud	Alpha	false
The Clouds from AVHRR Extended (CLAVR-x)	clavrx	Nominal	false
CMSAF CLAAS-2 data for SEVIRI-derived cloud products	cmsaf-claas2_l2_nc	Beta	false
Electro-L N2 MSU-GS data in HRIT format	electrol_hrit	Nominal	false
DSCOVR EPIC L1b hdf5	epic_l1b_h5	Beta	false
MTG FCI Level-1c NetCDF	fci_l1c_nc	Beta for full-disc FDHSI and HRFI, RSS not supported yet	true
MTG FCI L2 data in netCDF4 format	fci_l2_nc	Alpha	false
Generic Images e.g. GeoTIFF	generic_image	Nominal	false
GEOstationary Cloud Algorithm Test-bed	geocat	Nominal	false
	ghi_l1		false
Sentinel-3 SLSTR SST data in netCDF4 format	ghrsst_l2	Beta	false
GOES-R GLM Level 2	glm_l2	Beta	false
GOES Imager Level 1 (HRIT)	goes-imager_hrit	Nominal	false
GOES Imager Level 1 (netCDF)	goes-imager_nc	Beta	false
GPM IMERG level 3 precipitation data in HDF5 format	gpm_imerg	Nominal	false
GRIB2 format	grib	Beta	false
Hydrology SAF products in GRIB format	hsaf_grib	Beta, only h03, h03b, h05 and h05b currently supported	false
Hydrology SAF products in HDF5 format	hsaf_h5	Beta, only h10 currently supported	false
HY-2B Scatterometer level 2b data in HDF5 format from both EUMETSAT and NSOAS	hy2_scat_l2b_h5	Beta	false
IASI Level 2 data in HDF5 format	iasi_l2	Alpha	false
IASI All Sky Temperature and Humidity Profiles - Climate Data Record Release 1.1 - Metop-A and -B	iasi_l2_cdr_nc	Alpha	True
METOP IASI Level 2 SO2 in BUFR format	iasi_l2_so2_bufr	Beta	false
EPS-SG ICI L1B Radiance (NetCDF4)	ici_l1b_nc	Beta	false
Insat 3d IMG L1B HDF5	insat3d_img_l1b_h5	Beta, navigation still off	false
MTSAT-1R JAMI Level 1 data in JMA HRIT format	jami_hrit	Beta	false
LI Level-2 NetCDF Reader	li_l2_nc	Beta	false
AAPP MAIA VIIRS and AVHRR products in HDF5 format	maia	Nominal	false
	meris_nc_sen3		false
MERSI-2 L1B data in HDF5 format	mersi2_l1b	Beta	false
	mersi_ll_l1b		false
AAPP L1C in MHS format	mhs_l1c_aapp	Nominal	false
MIMIC Total Precipitable Water Product Reader in netCDF format	mimicTPW2_comp	Beta	false
MiRS Level 2 Precipitation and Surface Swath Product Reader in netCDF4 format	mirs	Beta	false
Terra and Aqua MODIS data in EOS-hdf4 level-1 format as produced by IMAPP and IPOPP or downloaded from LAADS	modis_l1b	Nominal	false
MODIS Level 2 (mod35) data in HDF-EOS format	modis_l2	Beta	false
Sentinel-2 A and B MSI data in SAFE format	msi_safe	Nominal	false
Arctica-M (N1) MSU-GS/A data in HDF5 format	msu_gsa_l1b	Beta	false
MTSAT-2 Imager Level 1 data in JMA HRIT format	mtsat2-imager_hrit	Beta	false
MFG (Meteosat 2 to 7) MVIRI data in netCDF format (FIDUCEO FCDR)	mviri_l1b_fiduceo_nc	Beta	false
EPS-SG MWI L1B Radiance (NetCDF4)	mwi_l1b_nc	Beta	false
EPS-SG MWS L1B Radiance (NetCDF4)	mws_l1b_nc	Beta	false
NUCAPS EDR Retrieval data in NetCDF4 format	nucaps	Nominal	false
NWCSAF GEO 2016 products in netCDF4 format (limited to SEVIRI)	nwcsaf-geo	Alpha	false
NWCSAF GEO 2013 products in HDF5 format (limited to SEVIRI)	nwcsaf-msg2013-hdf5	Defunct	false
NWCSAF PPS 2014, 2018 products in netCDF4 format	nwcsaf-pps_nc	Alpha, only standard swath based ouput supported (remapped netCDF and CPP products not supported yet)	false
Ocean color CCI Level 3S data reader	oceancolorcci_l3_nc	Nominal	false
Sentinel-3 A and B OLCI Level 1B data in netCDF4 format	olci_l1b	Nominal	true
Sentinel-3 A and B OLCI Level 2 data in netCDF4 format	olci_l2	Nominal	true
OMPS EDR data in HDF5 format	omps_edr	Beta	false
SAR Level 2 OCN data in SAFE format	safe_sar_l2_ocn	Defunct	false
Sentinel-1 A and B SAR-C data in SAFE format	sar-c_safe	Nominal	false
Reader for CF conform netCDF files written with Satpy	satpy_cf_nc	Nominal	false
Scatsat-1 Level 2b Wind field data in HDF5 format	scatsat1_l2b	defunct	false
SEADAS L2 Chlorphyll A product in HDF4 format	seadas_l2	Beta	false
MSG SEVIRI Level 1b (HRIT)	seviri_l1b_hrit	Nominal	true
MSG SEVIRI Level 1b in HDF format from ICARE (Lille)	seviri_l1b_icare	Defunct	false
MSG (Meteosat 8 to 11) SEVIRI data in native format	seviri_l1b_native	Nominal	false
MSG SEVIRI Level 1b NetCDF4	seviri_l1b_nc	Beta, HRV channel not supported	true
MSG (Meteosat 8 to 11) Level 2 products in BUFR format	seviri_l2_bufr	Alpha	false
MSG (Meteosat 8 to 11) SEVIRI Level 2 products in GRIB2 format	seviri_l2_grib	Nominal	false
Sentinel-3 A and B SLSTR data in netCDF4 format	slstr_l1b	Alpha	false
Sentinel-3 SLSTR Level 2 data in netCDF format	slstr_l2	defunct	false
SMOS level 2 wind data in NetCDF4 format	smos_l2_wind	Beta	false
TROPOMI Level 2 data in NetCDF4 format	tropomi_l2	Beta	false
Vaisala Global Lightning Dataset GLD360 data in ASCII format	vaisala_gld360	Beta	false
EPS-SG Visual Infrafred Imager (VII) Level 1B Radiance data in netCDF4 format	vii_l1b_nc	Beta	false
EPS-SG Visual Infrared Imager (VII) Level 2 data in netCDF4 format	vii_l2_nc	Beta	false
SNPP VIIRS SDR data in HDF5 Compact format	viirs_compact	Nominal	false
VIIRS EDR Active Fires data in netCDF4 & CSV .txt format	viirs_edr_active_fires	Beta	false
VIIRS EDR Flood data in HDF4 format	viirs_edr_flood	Beta	false
SNPP VIIRS Level 1b data in netCDF4 format	viirs_l1b	Nominal	false
VIIRS CSPP Cloud Mask data in NetCDF4 format	viirs_l2_cloud_mask_nc	beta	false
SNPP VIIRS data in HDF5 SDR format	viirs_sdr	Nominal	false
VIIRS Global Area Coverage from VIIRS Reflected Solar Band and Thermal Emission Band data for both Moserate resolution and Imager resolution channels.	viirs_vgac_l1c_nc		false
VIRR data in HDF5 format	virr_l1b	Beta	false

Indices and tables

• Index

• Module Index

• Search Page