Metadata-Version: 2.4
Name: madis-data
Version: 0.0.7
Summary: Python toolkit for downloading and processing Meteorological Assimilation Data Ingest System (MADIS) data.
Author: Jan Kazil
License-Expression: BSD-3-Clause
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cartopy
Requires-Dist: h5netcdf
Requires-Dist: geopandas
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: netcdf4
Requires-Dist: pandas
Requires-Dist: python-dateutil
Requires-Dist: requests
Requires-Dist: shapely
Requires-Dist: timezonefinder
Requires-Dist: tqdm
Requires-Dist: xarray
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Requires-Dist: pytest-cov>=5; extra == "dev"
Requires-Dist: ruff>=0.5; extra == "dev"
Requires-Dist: pre-commit>=3.7; extra == "dev"
Dynamic: license-file

# madis-data

**madis-data** is a Python toolkit to download, process, extract, interpolate, and plot Meteorological Assimilation Data Ingest System ([MADIS](https://madis-data.ncep.noaa.gov)) data. Currently, **madis-data** operates on the following publicly available MADIS [Mesonet](https://madis.ncep.noaa.gov/madis_mesonet.shtml) data:

- 2 m temperature
- 2 m dewpoint temperature
- 10 m west-east and south-north wind speed
- solar radiation
<!--
## Overview

## Key features
-->
## Workflow (using API)

The workflow is shown in the [HowTo](https://github.com/jankazil/madis-data/blob/main/notebooks/HowTo.ipynb) Jupyter notebook. The notebook performs the following tasks:

1. download MESONET surface observations data files for January 2026 from the [MADIS archive](https://madis-data.ncep.noaa.gov/madisPublic1/data/archive/),
2. extract January 2026 time series for stations in the state of Colorado of the following variables:
    - 2 m temperature,
    - 2 m dewpoint temperature,
    - 10 m west-east and south-north wind speed,
    - solar radiation,
3. save the time series in a netCDF file,
4. interpolate the time series to full-hourly time series,
5. save the full-hourly time series in a netCDF file,
6. plot the original and the full-hourly interpolated time series at an individual station over select time intervals,
7. plot the stations in the state of Colorado on a US map.

### Requirements
This notebook requires the Jupyter kernel madis-data, which is automaticaly installed as part of the madis-data conda development environment. The conda development environment can be installed from the root directory of the madis-data distribution with

```bash
make setup-dev-env
```
## Installation

### pip

```bash
pip install madis-data
```

### conda / mamba

```bash
mamba install -c jan.kazil -c conda-forge madis-data
```

<!--
## Executables

## Public API

### Modules

## Notes
-->
## Development

### Code Quality and Testing Commands

- `make fmt` - Runs `ruff format`, which reformats Python files according to the style rules in `pyproject.toml`.
- `make lint` - Runs `ruff check --fix`, which lints the code and auto-fixes what it can.
- `make check` - Runs formatting and linting.
- `make type` - Currently disabled. Intended to run `mypy` using the settings in `pyproject.toml`.
- `make test` - Runs `pytest` with the test settings configured in `pyproject.toml`.

## Disclaimers

The data accessed by this software are publicly available from NOAA's National Centers for Environmental Prediction (NCEP) and are subject to their terms of use. This project is not affiliated with or endorsed by NOAA.

This software uses U.S. Census Bureau and U.S. Energy Information Administration data, but is neither endorsed nor certified by the U.S. Census Bureau or the U.S. Energy Information Administration.

## Author

Jan Kazil - jan.kazil.dev@gmail.com - [github.com/jankazil/madis-data](https://github.com/jankazil/madis-data)

## License

BSD-3-Clause
