README.rst

March 7, 2025 · View on GitHub

.. image:: https://raw.githubusercontent.com/hyriver/HyRiver-examples/main/notebooks/_static/pynldas2_logo.png :target: https://github.com/hyriver/HyRiver

.. image:: https://joss.theoj.org/papers/b0df2f6192f0a18b9e622a3edff52e77/status.svg :target: https://joss.theoj.org/papers/b0df2f6192f0a18b9e622a3edff52e77 :alt: JOSS

.. |pygeohydro| image:: https://github.com/hyriver/pygeohydro/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/pygeohydro/actions/workflows/test.yml :alt: Github Actions

.. |pygeoogc| image:: https://github.com/hyriver/pygeoogc/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/pygeoogc/actions/workflows/test.yml :alt: Github Actions

.. |pygeoutils| image:: https://github.com/hyriver/pygeoutils/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/pygeoutils/actions/workflows/test.yml :alt: Github Actions

.. |pynhd| image:: https://github.com/hyriver/pynhd/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/pynhd/actions/workflows/test.yml :alt: Github Actions

.. |py3dep| image:: https://github.com/hyriver/py3dep/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/py3dep/actions/workflows/test.yml :alt: Github Actions

.. |pydaymet| image:: https://github.com/hyriver/pydaymet/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/pydaymet/actions/workflows/test.yml :alt: Github Actions

.. |pygridmet| image:: https://github.com/hyriver/pygridmet/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/pygridmet/actions/workflows/test.yml :alt: Github Actions

.. |pynldas2| image:: https://github.com/hyriver/pynldas2/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/pynldas2/actions/workflows/test.yml :alt: Github Actions

.. |async| image:: https://github.com/hyriver/async-retriever/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/async-retriever/actions/workflows/test.yml :alt: Github Actions

.. |signatures| image:: https://github.com/hyriver/hydrosignatures/actions/workflows/test.yml/badge.svg :target: https://github.com/hyriver/hydrosignatures/actions/workflows/test.yml :alt: Github Actions

================ ==================================================================== Package Description ================ ==================================================================== PyNHD_ Navigate and subset NHDPlus (MR and HR) using web services Py3DEP_ Access topographic data through National Map's 3DEP web service PyGeoHydro_ Access NWIS, NID, WQP, eHydro, NLCD, CAMELS, and SSEBop databases PyDaymet_ Access daily, monthly, and annual climate data via Daymet PyGridMET_ Access daily climate data via GridMET PyNLDAS2_ Access hourly NLDAS-2 data via web services HydroSignatures_ A collection of tools for computing hydrological signatures AsyncRetriever_ High-level API for asynchronous requests with persistent caching PyGeoOGC_ Send queries to any ArcGIS RESTful-, WMS-, and WFS-based services PyGeoUtils_ Utilities for manipulating geospatial, (Geo)JSON, and (Geo)TIFF data ================ ====================================================================

PyNLDAS2: Hourly NLDAS-2 Forcing Data

.. image:: https://img.shields.io/pypi/v/pynldas2.svg :target: https://pypi.python.org/pypi/pynldas2 :alt: PyPi

.. image:: https://img.shields.io/conda/vn/conda-forge/pynldas2.svg :target: https://anaconda.org/conda-forge/pynldas2 :alt: Conda Version

.. image:: https://codecov.io/gh/hyriver/pynldas2/branch/main/graph/badge.svg :target: https://codecov.io/gh/hyriver/pynldas2 :alt: CodeCov

.. image:: https://img.shields.io/pypi/pyversions/pynldas2.svg :target: https://pypi.python.org/pypi/pynldas2 :alt: Python Versions

.. image:: https://static.pepy.tech/badge/pynldas2 :target: https://pepy.tech/project/pynldas2 :alt: Downloads

.. image:: https://www.codefactor.io/repository/github/hyriver/pynldas2/badge :target: https://www.codefactor.io/repository/github/hyriver/pynldas2 :alt: CodeFactor

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json :target: https://github.com/astral-sh/ruff :alt: Ruff

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white :target: https://github.com/pre-commit/pre-commit :alt: pre-commit

.. image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/hyriver/HyRiver-examples/main?urlpath=lab/tree/notebooks :alt: Binder

Features

PyNLDAS2 is a part of HyRiver <https://github.com/hyriver/HyRiver>__ software stack that is designed to aid in hydroclimate analysis through web services. This package provides access NLDAS-2 Forcing dataset <https://ldas.gsfc.nasa.gov/nldas/v2/forcing>__ via Hydrology Data Rods <https://disc.gsfc.nasa.gov/information/tools?title=Hydrology+Data+Rods>__. Currently, only hourly data is supported. There are three main functions:

get_bycoords: Forcing data for a list of coordinates as a pandas.DataFrame or xarray.Dataset,
get_bygeom: Forcing data within a geometry as a xarray.Dataset,
get_grid_mask: NLDAS2 land/water grid mask <https://ldas.gsfc.nasa.gov/nldas/specifications>__ as a xarray.Dataset.

Both get_bygeom and get_bycoords functions save the intermediate files returned by the web service in a local cache folder (./cache in the current directory). The cache folder is created automatically when the functions are called for the first time. The cache folder is used to store the intermediate files to avoid re-downloading them. These two functions allow modifying the web service calls via two options:

conn_timeout: Sets the connection timeout in seconds. The default value is 5 minutes. This can be increaseed for larger requests. If running these functions fails with a connection timeout error, try increasing this value.
validate_filesize: If True, the functions compares the file size of the previously cached files in the ./cache folder, if they exist, with their size on the remote server. If the sizes do not match, the cached files are removed and they will be re-download. By default this is set to False since the files on the server rarely change. So, if a request has already been cached there shouldn't be a need for re-donwloading them from scratch. However, if you suspect that the files on the server have changed or the functions fails to process the cached files, you can set this to True or manually delete the cached files in the ./cache folder.

You can find some example notebooks here <https://github.com/hyriver/HyRiver-examples>__. You can also try using PyNLDAS2 without installing it on your system by clicking on the binder badge. A Jupyter Lab instance with the HyRiver stack pre-installed will be launched in your web browser, and you can start coding!

Moreover, requests for additional functionalities can be submitted via issue tracker <https://github.com/hyriver/pynldas2/issues>__.

Citation

If you use any of HyRiver packages in your research, we appreciate citations:

.. code-block:: bibtex

@article{Chegini_2021,
    author = {Chegini, Taher and Li, Hong-Yi and Leung, L. Ruby},
    doi = {10.21105/joss.03175},
    journal = {Journal of Open Source Software},
    month = {10},
    number = {66},
    pages = {1--3},
    title = {{HyRiver: Hydroclimate Data Retriever}},
    volume = {6},
    year = {2021}
}

Installation

You can install pynldas2 using pip:

.. code-block:: console

$ pip install pynldas2

Alternatively, pynldas2 can be installed from the conda-forge repository using Conda <https://docs.conda.io/en/latest/>__:

.. code-block:: console

$ conda install -c conda-forge pynldas2

Quick start

The NLDAS2 database provides forcing data at 1/8th-degree grid spacing and range from 01 Jan 1979 to present. Let's take a look at NLDAS2 grid mask that includes land, water, soil, and vegetation masks:

.. code-block:: python

import pynldas2 as nldas

grid = nldas.get_grid_mask()

.. image:: https://raw.githubusercontent.com/hyriver/HyRiver-examples/main/notebooks/_static/nldas_grid.png :target: https://github.com/hyriver/HyRiver-examples/blob/main/notebooks/nldas.ipynb

Next, we use PyGeoHydro <https://github.com/hyriver/pygeohydro>__ to get the geometry of a HUC8 with ID of 1306003, then we get the forcing data within the obtained geometry.

.. code-block:: python

from pygeohydro import WBD

huc8 = WBD("huc8")
geometry = huc8.byids("huc8", "13060003").geometry[0]
clm = nldas.get_bygeom(geometry, "2010-01-01", "2010-01-31", 4326)

.. image:: https://raw.githubusercontent.com/hyriver/HyRiver-examples/main/notebooks/_static/nldas_humidity.png :target: https://github.com/hyriver/HyRiver-examples/blob/main/notebooks/nldas.ipynb

Road Map

Add PET calculation functions similar to PyDaymet <https://github.com/hyriver/pydaymet>__ but at hourly timescale.
Add a command line interfaces.

Contributing

Contributions are appreciated and very welcomed. Please read CONTRIBUTING.rst <https://github.com/hyriver/pynldas2/blob/main/CONTRIBUTING.rst>__ for instructions.