API Reference Manual

This guide provides documentation for all modules, and functions, within PyScanCf for those in the public API.

pyscancf.cfrad(input_dir, output_dir, scan_type='B', dualpol=False, gridder=False, plot=None, nf=None)

Aggregates data to cfradial1 data.

input_dir(str): Enter path of single sweep data directory,

output_dir(str): Enter the path for output data,

scan_type(str): “B”, “C”. B is for short range PPI, & C is for long range PPI.

dualpol(bool): True, False. (If the data contains dual-pol products e.g., ZDR, RHOHV),

gridder(bool): True, False,

plot(str): ‘REF’, ‘VELH’, ‘WIDTH’, ‘ALL’,

nf(int): Number of files to group together

pyscancf.get_grid(radar, grid_shape=(30, 500, 500), height=15, length=250)

Returns grid object from radar object.

grid_shape=(60, 500, 500), no. of bins of z,y,x respectively.

height:(int) = 15, height in km

length:(int) = 250, Range of radar in km

maxcappi.plot_cappi(grid, moment, cmap=None, vmin=None, vmax=None, title=None, colorbar=True, range_rings=True, crosshair=True, dpi=100, show_progress=True, savedir=None, show_figure=True, **kwargs)

Plots CAPPI

grid: pyart grid object,

moment(str): radar moment e.g., “REF”, “VELH”, “WIDTH”

cmap: matplotlib colormap, optional

vmin: minimum value for color scaling, optional

vmax: maximum value for color scaling, optional

title: plot title, optional

colorbar: bool, plot colorbar or not, (default: True), optional

range_rings: bool, (50 km interval), (default: True), optional

crosshair: bool, (default: True), optional

dpi: int, (default: 100), optional

show_progress: bool, (default: True)

savedir: string, path to save the plot, optional