satpy.demo package

Module contents

Demo data download helper functions.

Each get_* function below downloads files to a local directory and returns a list of paths to those files. Some (not all) functions have multiple options for how the data is downloaded (via the method keyword argument) including:

  • gcsfs:

    Download data from a public google cloud storage bucket using the gcsfs package.

  • unidata_thredds:

    Access data using OpenDAP or similar method from Unidata’s public THREDDS server (https://thredds.unidata.ucar.edu/thredds/catalog.html).

  • uwaos_thredds:

    Access data using OpenDAP or similar method from the University of Wisconsin - Madison’s AOS department’s THREDDS server.

  • http:

    A last resort download method when nothing else is available of a tarball or zip file from one or more servers available to the Satpy project.

  • uw_arcdata:

    A network mount available on many servers at the Space Science and Engineering Center (SSEC) at the University of Wisconsin - Madison. This is method is mainly meant when tutorials are taught at the SSEC using a Jupyter Hub server.

To use these functions, do:

>>> from satpy import Scene, demo
>>> filenames = demo.get_us_midlatitude_cyclone_abi()
>>> scn = Scene(reader='abi_l1b', filenames=filenames)
satpy.demo.get_hurricane_florence_abi(base_dir='.', method=None, force=False, channels=None, num_frames=10)[source]

Get GOES-16 ABI (Meso sector) data from 2018-09-11 13:00Z to 17:00Z.

Parameters
  • base_dir (str) – Base directory for downloaded files.

  • method (str) – Force download method for the data if not already cached. Allowed options are: ‘gcsfs’. Default of None will choose the best method based on environment settings.

  • force (bool) – Force re-download of data regardless of its existence on the local system. Warning: May delete non-demo files stored in download directory.

  • channels (list) – Channels to include in download. Defaults to all 16 channels.

  • num_frames (int or slice) – Number of frames to download. Maximum 240 frames. Default 10 frames.

Size per frame (all channels): ~15MB

Total size (default 10 frames, all channels): ~124MB

Total size (240 frames, all channels): ~3.5GB

satpy.demo.get_us_midlatitude_cyclone_abi(base_dir='.', method=None, force=False)[source]

Get GOES-16 ABI (CONUS sector) data from 2019-03-14 00:00Z.

Parameters
  • base_dir (str) – Base directory for downloaded files.

  • method (str) – Force download method for the data if not already cached. Allowed options are: ‘gcsfs’. Default of None will choose the best method based on environment settings.

  • force (bool) – Force re-download of data regardless of its existence on the local system. Warning: May delete non-demo files stored in download directory.

Total size: ~110MB