API Reference Manual¶

Release

1.12

Date

Mar 25, 2020

This guide provides documentation for all modules, function, methods, and classes within Py-ART for those in the public API.

Documentation is broken down by directory and module.

pyart.core

Core Py-ART classes and function for interacting with weather radar data.

pyart.io

Functions to read and write radar and grid data to and from a number of file formats.

pyart.aux_io

Additional classes and functions for reading and writing data from a number of file formats.

pyart.config

Py-ART configuration.

pyart.correct

Correct radar fields.

pyart.exceptions

Custom Py-ART exceptions.

pyart.retrieve

Radar retrievals.

pyart.graph

Creating plots of Radar and Grid fields.

pyart.filters

Classes for specifying what gates are included and excluded from routines.

pyart.lazydict

A dictionary-like class supporting lazy loading of specified keys.

pyart.map

Py-ART has a robust function for mapping radar data from the collected radar coordinates to Cartesian coordinates.

pyart.util

Miscellaneous utility functions.

pyart.bridge

Py-ART can act as bridge to other community software projects.

pyart.testing

Utilities helpful when writing and running unit tests such as sample files and sample objects.

pyart._debug_info([stream])

Print out version and status information for debugging.