pynldas2.pynldas2
Contents
pynldas2.pynldas2
#
Get hourly NLDAS2 forcing data.
Module Contents#
- pynldas2.pynldas2.get_bycoords(coords, start_date, end_date, crs=4326, variables=None, to_xarray=False, n_conn=4)#
Get NLDAS climate forcing data for a list of coordinates.
- Parameters
coords (
list
oftuples
) – List of (lon, lat) coordinates.start_date (
str
) – Start date of the data.end_date (
str
) – End date of the data.crs (
str
,int
, orpyproj.CRS
, optional) – The CRS of the input coordinates, defaults toEPSG:4326
.variables (
str
orlist
ofstr
, optional) – Variables to download. If None, all variables are downloaded. Valid variables are:prcp
,pet
,temp
,wind_u
,wind_v
,rlds
,rsds
, andhumidity
.to_xarray (
bool
, optional) – If True, the data is returned as an xarray dataset.n_conn (
int
, optional) – Number of parallel connections to use for retrieving data, defaults to 4. The maximum number of connections is 4, if more than 4 are requested, 4 connections will be used.
- Returns
pandas.DataFrame
– The requested data as a dataframe.
- pynldas2.pynldas2.get_bygeom(geometry, start_date, end_date, geo_crs, variables=None, n_conn=4)#
Get hourly NLDAS climate forcing within a geometry at 0.125 resolution.
- Parameters
geometry (
shapely.Polygon
,shapely.MultiPolygon
, ortuple
oflength 4
) – Input polygon or a bounding box like so (xmin, ymin, xmax, ymax).start_date (
str
) – Start date of the data.end_date (
str
) – End date of the data.geo_crs (
int
,str
, orpyproj.CRS
) – CRS of the input geometryvariables (
str
orlist
ofstr
, optional) – Variables to download. If None, all variables are downloaded. Valid variables are:prcp
,pet
,temp
,wind_u
,wind_v
,rlds
,rsds
, andhumidity
.n_conn (
int
, optional) – Number of parallel connections to use for retrieving data, defaults to 4. It should be less than 4.
- Returns
xarray.Dataset
– The requested forcing data.
- pynldas2.pynldas2.get_grid_mask()#
Get the NLDAS2 grid that contains the land/water/soil/vegetation mask.
- Returns
xarray.Dataset
– The grid mask.