API Reference Manual#

Release

1.14.1.post7

Date

Dec 05, 2022

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.

core

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

io

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

aux_io

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

config

Py-ART configuration.

correct

Correct radar fields.

exceptions

Custom Py-ART exceptions.

retrieve

Radar retrievals.

graph

Creating plots of Radar and Grid fields.

filters

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

lazydict

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

map

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

util

Miscellaneous utility functions.

bridge

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

testing

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

_debug_info([stream])

Print out version and status information for debugging.