Metadata-Version: 2.4
Name: arm-adapt
Version: 0.1.1
Summary: Real-Time Analysis, Tracking, and Adaptive Radar Sampling of Convective Storms
Author-email: "Bhupendra A. Raut" <braut@anl.gov>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://arm-doe.github.io/Adapt/
Project-URL: Documentation, https://arm-doe.github.io/Adapt/
Project-URL: Repository, https://github.com/ARM-DOE/Adapt.git
Project-URL: Issues, https://github.com/ARM-DOE/Adapt/issues
Keywords: Radar,NEXRAD,tracking,cell-detection,adaptive-sampling,Thunderstorm,Nowcasting,TITAN,Py-ART,ARM
Platform: Linux
Platform: Mac OS-X
Platform: Unix
Platform: Windows
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: xarray
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: scikit-image
Requires-Dist: matplotlib
Requires-Dist: networkx
Requires-Dist: h5py
Requires-Dist: netCDF4
Requires-Dist: tqdm
Requires-Dist: pydantic>=2.0
Requires-Dist: arm_pyart
Requires-Dist: opencv-python
Requires-Dist: nexradaws
Requires-Dist: cartopy>=0.21
Requires-Dist: contextily
Requires-Dist: pyproj
Requires-Dist: pyarrow
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.15; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Dynamic: license-file

# Adapt

[![CI](https://github.com/ARM-DOE/Adapt/actions/workflows/ci.yml/badge.svg)](https://github.com/ARM-DOE/Adapt/actions?query=workflow%3ACI)
[![Codecov](https://img.shields.io/codecov/c/github/ARM-DOE/Adapt.svg?logo=codecov)](https://codecov.io/gh/ARM-DOE/Adapt)
[![Docs](https://img.shields.io/badge/docs-users-4088b8.svg)](https://arm-doe.github.io/Adapt/)
[![Downloads](https://img.shields.io/github/downloads/ARM-DOE/Adapt/total?label=downloads)](https://github.com/ARM-DOE/Adapt/releases)
[![ARM](https://img.shields.io/badge/Sponsor-ARM-blue.svg?colorA=00c1de&colorB=00539c)](https://www.arm.gov/)

**Real-time processing for informed adaptive scanning of ARM weather radar operations and field campaigns.**

`Adapt` is a configuration-driven modular framework for near real-time analysis of convective systems designed to support the adaptive sampling and study of convective storms and their life cycles. The system implements a modular pipeline that ingests radar observations, performs gridding and segmentation to identify convective cells, and maintains their identity through time using tracking. It further derives cell-level properties and motion to characterize storm evolution and generate candidate targets for adaptive radar scanning.

Adapt operates in both real-time and archival modes, producing standardized data products in the form of gridded fields, tabular summaries, and relational tracking records. Its design emphasizes reproducibility, extensibility, and consistency, allowing new analysis methods and data sources to be integrated without altering core workflows.

Currently, it ingests NEXRAD Level-II data, performs gridding/segmentation/analysis, and writes results for downstream visualization and scientific workflows.

## Installation

1. Go to the [releases page](https://github.com/ARM-DOE/Adapt/releases) and download the latest `Source code (tar.gz)` or `Source code (zip)`.

2. Extract and create the environment:

```bash
# extract
tar -xzf Adapt-<version>.tar.gz
cd Adapt-<version>

# create environment and install adapt
mamba env create -f environment.yml
mamba activate adapt_env
```

## Quickstart

```bash
adapt run-nexrad --radar KLOT --base-dir ~/adapt_output
adapt dashboard --repo ~/adapt_output
```

Open the dashboard in a second terminal for live viewing.



## Documentation

- Detailed usage, configuration, outputs, and troubleshooting: `docs/USAGE.md`

## Status and compatibility

**Status: Alpha.** `Adapt` is under active development and is provided for early testing and evaluation.  
**No backward compatibility is guaranteed** for code, APIs, configuration, or generated data products (e.g., SQLite/Parquet/NetCDF). Expect breaking changes between commits and releases.  
Contribution guidelines and a roadmap will be published in a future release.

## Funding

`Adapt` is supported by the U.S. Department of Energy as part of the Atmospheric Radiation Measurement (ARM), an Office of Science User Facility.

## License

BSD license; see `LICENSE` for terms and disclaimer.
