Skip to main content

Load `U.S. Climate Reference Network <https://www.ncei.noaa.gov/access/crn/>`__ (USCRN) data.

Project description

uscrn

Easily load U.S. Climate Reference Network (USCRN) data.

Version on PyPI CI status Documentation status Test coverage pre-commit.ci status Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

With uscrn, fetching and loading years of data for all USCRN sites[^a] takes just one line of code[^b].

Example:

import uscrn

df = uscrn.get_data(2019, "hourly", n_jobs=6)  # pandas.DataFrame

ds = uscrn.to_xarray(df)  # xarray.Dataset, with soil depth dimension if applicable (hourly, daily)

Both df (pandas) and ds (xarray) include dataset and variable metadata. For df, these are in df.attrs and can be preserved by writing to Parquet with the PyArrow engine[^d] with pandas v2.1+.

df.to_parquet("uscrn_2019_hourly.parquet", engine="pyarrow")

Conda install example[^c]:

conda create -n crn -c conda-forge python=3.10 joblib numpy pandas pyyaml requests xarray pyarrow netcdf4
conda activate crn
pip install --no-deps uscrn

[^a]: Use uscrn.load_meta() to load the site metadata table. [^b]: Not counting the import statement... [^c]: uscrn is not yet on conda-forge. [^d]: Or the fastparquet engine with fastparquet v2024.2.0+.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uscrn-0.1.0.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

uscrn-0.1.0-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file uscrn-0.1.0.tar.gz.

File metadata

  • Download URL: uscrn-0.1.0.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for uscrn-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bddf54d4a0e12bd7f2524f9d8b8982cc380c44906346160afdc481086063b116
MD5 02e9033f29f2d1ba05fc8fc5bed6498a
BLAKE2b-256 59cbaf684e861dbe21fb72d141e4aae0f13aa68604be6a1468db1fbc5c443cd5

See more details on using hashes here.

File details

Details for the file uscrn-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: uscrn-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for uscrn-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 723f959662ea630a03ec0fefbd0bd178d1544e4f59ca006336b0d20cc054573b
MD5 de4c97c0a926c443eba17f1eef5c4321
BLAKE2b-256 ffb4a7b8cbd89e93c1964f716d7dd692904512f79643c448106e19927042f9ab

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page