cmaqsatproc package

Subpackages

Submodules

cmaqsatproc.cmaq module

cmaqsatproc.cmaq.open_griddesc(GDNAM, gdpath=None)[source]

Create an xarray Dataset that defines a CMAQ grid using GRIDDESC

Parameters:

  • GDNAM (str) – Name of grid as defined in GRIDDESC file

  • gdpath (str) – Path to GRIDDESC file. If None (default), use contents of default_griddesc_txt instead. default_griddesc_txt can be modified directly, although that is discouraged.

Returns:

gf – File with coordinates based on GDNAM in gdpath

Return type:

xarray.Dataset

cmaqsatproc.cmaq.open_ioapi(path, **kwargs)[source]

Open an IOAPI file in NetCDF format using xarray and construct coordinate variables. (time based on TFLAG or properties, ROW/COL in projected space, and LAY based on VGTYP, VGLVLS, and VGTOP)

Parameters:

  • path (str) – Path to the IOAPI file in NetCDF format

  • kwargs (mappable) – Passed to xarray.open_dataset as keyword arguments

Returns:

qf – File with data and coordinates based on path

Return type:

xarray.Dataset

cmaqsatproc.config module

Module contents

Overview

cmaqsatproc provides satellite data processing for CMAQ. This has four basic steps:

  1. Create a custom level 3 gridded satellite product on CMAQ grid,

  2. Subset CMAQ consistent with satellite overpass and valid samples,

  3. integrate CMAQ mixing ratios to number density (or other metric), and

  4. apply CMAQ air mass factor to the satellite.

Core Objects

  • open_griddesc : define a CMAQ grid by name or GRIDDESC.

  • reader_dict : dictionary of satellite readers.

  • open_ioapi : Used to open CMAQ and MCIP data.

  • print_reader_list : useful to find out what can be done.

By TropOMI NO2 Example

cmaqsatproc.open_griddesc(GDNAM, gdpath=None)[source]

Create an xarray Dataset that defines a CMAQ grid using GRIDDESC

Parameters:

  • GDNAM (str) – Name of grid as defined in GRIDDESC file

  • gdpath (str) – Path to GRIDDESC file. If None (default), use contents of default_griddesc_txt instead. default_griddesc_txt can be modified directly, although that is discouraged.

Returns:

gf – File with coordinates based on GDNAM in gdpath

Return type:

xarray.Dataset

cmaqsatproc.open_ioapi(path, **kwargs)[source]

Open an IOAPI file in NetCDF format using xarray and construct coordinate variables. (time based on TFLAG or properties, ROW/COL in projected space, and LAY based on VGTYP, VGLVLS, and VGTOP)

Parameters:

  • path (str) – Path to the IOAPI file in NetCDF format

  • kwargs (mappable) – Passed to xarray.open_dataset as keyword arguments

Returns:

qf – File with data and coordinates based on path

Return type:

xarray.Dataset

cmaqsatproc.print_reader_list()[source]

Print to the screen a short description reader_dict keys and a short description of the reader they are associated with.