Developer Reference Manual#

Release:

0.5.0

Date:

Sep 08, 2026

This is the developer reference guide for ADAM which covers most of the available functions, modules, and classes.

io Module#

Module containing functions to load and preprocess radar data for inference.

adam.io (adam.io)#

This module handles the preprocessing of radar data.

RadarImage()

This class contains the basic data for predicting the lake-breeze front location from radar.

preprocess_radar_image(radar[, rad_time, ...])

This module will preprocess the NEXRAD radar data for inference into the lake-breeze prediction model of ADAM.

model Module#

Main module for inference.

adam.model (adam.model)#

This module handles the inference of lake breeze location from radar data.

infer_lake_breeze(radar_scan[, model_name, ...])

This module will infer the location of the lake breeze from a radar image.

infer_lake_breeze_batch(radar_list[, ...])

This module will infer the location of the lake breeze from a batch of radar images.

vis Module#

Main module for visualization.

adam.vis (adam.vis)#

This module handles the visualization of the lake breeze mask on radar data.

visualize_lake_breeze(radar_scan[, ...])

This module will visualize the lake breeze using PyART's pyart.graph.RadarMapDisplay().

triggering Module#

Main module for triggering lidar scans.

ADAM Triggering Module#

This module handles the generation of scan strategies and triggering of the lidar based on radar data.

make_scan_file(elevations, azimuths, ...[, ...])

Makes a CSM scanning strategy file for a Halo Photonics Doppler Lidar.

send_scan(file_name, lidar_ip_addr, ...[, ...])

Sends a scan to the lidar

trigger_lidar_ppis_from_mask(rad_scan, ...)

Triggers a PPI scan on the lidar using a scan strategy generated from a lake breeze mask.

trigger_lidar_rhi_from_mask(rad_scan, ...[, ...])

Triggers a PPI scan on the lidar using a scan strategy generated from a lake breeze mask.

testing Module#

Main module for testing.

adam.testing (adam.testing)#

This module handles testing utilities for ADAM.

FakeSSHClient()

A fake SSH client for testing purposes.

FakeSFTP()

A fake SFTP client for testing purposes.

TEST_RHI_FILE

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

TEST_PPI_FILE

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

TEST_PPI_TRIGGERED_SCAN

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

TEST_RHI_TRIGGERED_SCAN

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

util Module#

Module with various utilities.

ADAM Utility Functions (adam.util)#

This module contains utility functions for the ADAM package.

azimuth_point(instrument_lon, ...[, index, ...])

Calculate the azimuth angle from the radar instrument to each pixel in the radar image.

azimuth_from_ellipse(instrument_lon, ...[, ...])

Fit an ellipse to the lake breeze mask via PCA, find the endpoints of the major axis (leftmost and rightmost mask pixels projected onto that axis), and return the azimuth from the instrument perpendicular to the major axis.

aeqd_to_lonlat(x, y, lon_0, lat_0)

Convert azimuthal equidistant coordinates to longitude and latitude on the WGS84 ellipsoid.