Metadata-Version: 2.4
Name: usdata
Version: 0.15.0
Summary: Unified Python SDK and CLI for discovering, fetching, and tracking provenance of U.S. public scientific data
Keywords: noaa,usgs,nasa,open-data,scientific-data,provenance
Author: Jake Van Slyke
Author-email: Jake Van Slyke <jakervanslyke@gmail.com>
License-Expression: Apache-2.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Dist: httpx>=0.28.1
Requires-Dist: pydantic>=2.7
Requires-Dist: pyyaml>=6.0
Requires-Dist: typer>=0.18
Requires-Dist: eccodes>=2.48 ; extra == 'grib'
Requires-Dist: eccodeslib>=2.48 ; sys_platform == 'linux' and extra == 'grib'
Requires-Dist: xarray>=2025.1 ; extra == 'grib'
Requires-Dist: numpy>=2 ; extra == 'grib'
Requires-Dist: xarray>=2025.1 ; extra == 'netcdf'
Requires-Dist: h5netcdf[h5py]>=1.8.1 ; extra == 'netcdf'
Requires-Dist: pandas>=2.2 ; extra == 'pandas'
Requires-Dist: xradar>=0.12.0 ; extra == 'radar'
Requires-Python: >=3.11
Project-URL: Homepage, https://usdata.dev/
Project-URL: Documentation, https://docs.usdata.dev/
Project-URL: Repository, https://github.com/jakeryderv/usdata
Provides-Extra: grib
Provides-Extra: netcdf
Provides-Extra: pandas
Provides-Extra: radar
Description-Content-Type: text/markdown

# usdata

Discover U.S. scientific datasets, fetch their files, and keep a reproducible
record of where every input came from. Use the same Python SDK or CLI across
supported NOAA and USGS datasets.

**Pre-alpha.** These docs describe the current source checkout. Features marked
**Unreleased** require a source installation; consult the
[changelog](CHANGELOG.md) for published versions. Other providers are planned.

Project home: [usdata.dev](https://usdata.dev/).
[Documentation and getting started](https://docs.usdata.dev/).

## Start here

```sh
pip install usdata
usdata search precipitation --location Oklahoma
usdata info noaa:ghcn-daily
```

Search uses a curated registry. Fetching contacts the upstream service; readers
open the resulting local files. Provenance and manifests connect those steps.

- [Quick start and documentation](docs/index.md)
- [Fetch and analyze data](docs/guides/fetch-and-analyze.md)
- [Runnable examples with saved outputs](examples/README.md)
- [Readers](docs/reference/readers.md) and [reproducible manifests](docs/reference/manifests.md)

## Source installation

For features marked **Unreleased**, install this checkout with
[uv](https://docs.astral.sh/uv/):

```sh
git clone https://github.com/jakeryderv/usdata && cd usdata
uv sync --extra pandas
uv run usdata info noaa:coops-water-levels
```

Run source examples from this checkout with `uv run usdata` (CLI) or
`uv run python` (Python). The pandas extra enables CSV reading; use `--extra radar`,
`--extra netcdf`, or `--extra grib` for those formats. For contribution checks, continue with
[development setup](#development).

## Providers

Browse the [dataset catalog](docs/generated/catalog/index.md) for current support,
release availability, and dataset details. [Provider access notes](docs/providers/README.md)
explain agency-specific services; the [roadmap](docs/roadmap.md) describes priorities.

## Development

```sh
just setup
just check
```

See [development setup and commands](docs/project.md#development),
[contributing](CONTRIBUTING.md), and [architecture](docs/architecture.md).

## License

[Apache-2.0](LICENSE).
