podpac.datalib.SMAPSource

class podpac.datalib.SMAPSource(**kwargs)[source]

Bases: podpac.datalib.smap.SMAPSessionMixin, podpac.core.node.DiskCacheMixin, podpac.core.data.pydap_source.PyDAP

Accesses SMAP data given a specific openDAP URL. This is the base class giving access to SMAP data, and knows how to extract the correct coordinates and data keys for the soil moisture data.

date_file_url_re

Regular expression used to retrieve date from self.source (OpenDAP Url)

Type

SRE_Pattern

date_time_file_url_re

Regular expression used to retrieve date and time from self.source (OpenDAP Url)

Type

SRE_Pattern

layer_key

Key used to retrieve data from OpenDAP dataset. This specifies the key used to retrieve the data

Type

str

nan_vals

List of values that should be treated as no-data (these are replaced by np.nan)

Type

list

root_data_key

String the prepends every or most keys for data in the OpenDAP dataset

Type

str

Alternative Constructors

from_definition(definition)

Create podpac Node from a dictionary definition.

from_json(s)

Create podpac Node from a JSON definition.

Methods

__init__(**kwargs)

Do not overwrite me

create_output_array(coords[, data])

Initialize an output data array

eval(coordinates[, output])

Evaluates this node using the supplied coordinates.

eval_group(group)

Evaluate the node for each of the coordinates in the group.

find_coordinates()

Get the available coordinates for the Node.

from_url(url)

Create podpac Node from a WMS/WCS request.

get_cache(key[, coordinates])

Get cached data for this node.

get_coordinates()

Returns a Coordinates object that describes the coordinates of the data source.

get_data(coordinates, coordinates_index)

This method must be defined by the data source implementing the DataSource class.

has_cache(key[, coordinates])

Check for cached data for this node.

init()

Overwrite this method if a node needs to do any additional initialization after the standard initialization.

load(path)

Create podpac Node from file.

put_cache(data, key[, coordinates, overwrite])

Cache data for this node.

rem_cache(key[, coordinates, mode])

Clear cached data for this node.

save(path)

Write node to file.

set_coordinates(coordinates[, force])

Set the coordinates.

set_credentials([username, password])

Shortcut to podpac.authentication.set_crendentials() using class member self.hostname for the hostname

trait_is_defined(name)

Attributes

attrs

List of node attributes

auth_required

available_times

base_ref

Default reference/name in node definitions

boundary

An instance of a Python dict.

cache_coordinates

A boolean (True, False) trait.

cache_ctrl

A trait whose value must be an instance of a specified class.

cache_output

A boolean (True, False) trait.

coordinate_index_type

An enum whose value must be in a given sequence.

coordinates

{coordinates}

data_key

PyDAP data_key, constructed from the layer_key and root_data_key

dataset

date_file_url_re

date_time_file_url_re

definition

dtype

A trait which allows any value.

force_eval

A boolean (True, False) trait.

hash

hostname

interpolation

interpolation_class

Get the interpolation class currently set for this data source.

interpolators

Return the interpolators selected for the previous node evaluation interpolation.

json

json_pretty

keys

lat_key

OpenDap dataset key for latitude.

layer_key

A trait for unicode strings.

lon_key

OpenDap dataset key for longitude.

nan_vals

output

A trait for unicode strings.

outputs

An instance of a Python list.

password

Returns password stored in settings for accessing self.hostname.

product

SMAP product from the OpenDAP URL

product_url

root_data_key

A trait for unicode strings.

session

source

A trait for unicode strings.

style

A trait whose value must be an instance of a specified class.

units

A trait for unicode strings.

username

Returns username stored in settings for accessing self.hostname.

version

SMAP product version from the OpenDAP URL

Members

__init__(**kwargs)

Do not overwrite me

property available_times
cache_coordinates

A boolean (True, False) trait.

property data_key

PyDAP data_key, constructed from the layer_key and root_data_key

date_file_url_re = re.compile('[0-9]{8}')
date_time_file_url_re = re.compile('[0-9]{8}T[0-9]{6}')
get_coordinates()[source]

Returns a Coordinates object that describes the coordinates of the data source.

In most cases, this method is defined by the data source implementing the DataSource class. If method is not implemented by the data source, it will try to return self.coordinates if self.coordinates is not None.

Otherwise, this method will raise a NotImplementedError.

Returns

The coordinates describing the data source array.

Return type

podpac.Coordinates

Notes

Need to pay attention to: - the order of the dimensions - the stacking of the dimension - the type of coordinates

Coordinates should be non-nan and non-repeating for best compatibility

get_data(coordinates, coordinates_index)[source]

This method must be defined by the data source implementing the DataSource class. When data source nodes are evaluated, this method is called with request coordinates and coordinate indexes. The implementing method can choose which input provides the most efficient method of getting data (i.e via coordinates or via the index of the coordinates).

Coordinates and coordinate indexes may be strided or subsets of the source data, but all coordinates and coordinate indexes will match 1:1 with the subset data.

This method may return a numpy array, an xarray DaraArray, or a podpac UnitsDataArray. If a numpy array or xarray DataArray is returned, podpac.data.DataSource.evaluate() will cast the data into a UnitsDataArray using the requested source coordinates. If a podpac UnitsDataArray is passed back, the podpac.data.DataSource.evaluate() method will not do any further processing. The inherited Node method create_output_array can be used to generate the template UnitsDataArray in your DataSource. See podpac.Node.create_output_array() for more details.

Parameters
  • coordinates (podpac.Coordinates) – The coordinates that need to be retrieved from the data source using the coordinate system of the data source

  • coordinates_index (List) – A list of slices or a boolean array that give the indices of the data that needs to be retrieved from the data source. The values in the coordinate_index will vary depending on the coordinate_index_type defined for the data source.

Returns

A subset of the returned data. If a numpy array or xarray DataArray is returned, the data will be cast into UnitsDataArray using the returned data to fill values at the requested source coordinates.

Return type

np.ndarray, xr.DataArray, podpac.UnitsDataArray

property lat_key

OpenDap dataset key for latitude.

layer_key

A trait for unicode strings.

property lon_key

OpenDap dataset key for longitude.

nan_vals = [-9999.0]
property product

SMAP product from the OpenDAP URL

root_data_key

A trait for unicode strings.

property version

SMAP product version from the OpenDAP URL