podpac.datalib.SMAP

class podpac.datalib.SMAP(**kwargs: Any)

Bases: EGI

SMAP Node. For more information about SMAP, see https://nsidc.org/data/smap

SMAP interface using the EGI Data Portal https://developer.earthdata.nasa.gov/sdps/programmatic-access-docs with the base URL: https://n5eil01u.ecs.nsidc.org/egi/request

To access data from this node, an Earthdata login is required. This can either be specified when creating the node: `python smap = SMAP(username="your_user_name", password="your_password") ` OR you can set the following PODPAC settings: `python podpac.settings["username@urs.earthdata.nasa.gov"] = "your_user_name" podpac.settings["password@urs.earthdata.nasa.gov"] = "your_password" podpac.settings.save()  # To have this information persist smap = SMAP() `

Parameters:

• product (str) – One of the :list:`SMAP_PRODUCTS` strings

• check_quality_flags (bool, optional) – Default is True. If True, data will be filtered based on the SMAP data quality flag, and only high quality data is returned.

• data_key (str, optional) – Default will return soil moisture and is set automatically based on the product selected. Other possible data keys can be found

nan_vals

Nan values in SMAP data

Type:

list

username

Earthdata username (https://urs.earthdata.nasa.gov/) If undefined, node will look for a username under setting key “username@urs.earthdata.nasa.gov”

Type:

str, optional

password

Earthdata password (https://urs.earthdata.nasa.gov/) If undefined, node will look for a password under setting key “password@urs.earthdata.nasa.gov”

Type:

str, optional

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
append_file(all_data, data)	Append data
create_output_array(coords[, data, attrs, ...])	Initialize an output data array
eval(coordinates, **kwargs)	Wraps the super Node.eval method in order to cache with the correct 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_name_params(name[, params])	Create podpac Node from a WMS/WCS request.
from_url(url)	Create podpac Node from a WMS/WCS request.
get_bounds([crs])	Get the full available coordinate bounds for the Node.
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)
get_source_data([bounds])	Get source data, without interpolation.
get_token()	Get token for EGI interface using Earthdata credentials
get_ui_spec([help_as_html])
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.
probe([lat, lon, time, alt, crs])	Evaluates every part of a node / pipeline at a point and records which nodes are actively being used.
put_cache(data, key[, coordinates, expires, ...])	Cache data for this node.
read_file(filelike)	Interpret individual SMAP file from EGI zip archive.
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
token_valid()	Validate EGI token set in token attribute of EGI Node
trait_defaults(*names, **metadata)	Return a trait's default value or a dictionary of them
trait_has_value(name)	Returns True if the specified trait has a value.
trait_is_defined(name)
trait_values(**metadata)	A dict of trait names and their values.

Attributes

attrs	List of node attributes
base_ref	Default reference/name in node definitions
base_url	A trait for unicode strings.
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.
check_quality_flags	A boolean (True, False) trait.
coordinate_index_type	An enum whose value must be in a given sequence.
coordinates
coverage
data	A trait which allows any value.
data_key	A trait for unicode strings.
definition
dims	datasource dims.
dtype	An enum whose value must be in a given sequence.
force_eval	A boolean (True, False) trait.
hash
interpolation
json	Definition for this node in JSON format.
json_pretty	Definition for this node in JSON format, with indentation suitable for display.
lat_key
lon_key
min_bounds_span	An instance of a Python dict.
nan_val	A trait which allows any value.
nan_vals
output	A trait for unicode strings.
outputs	An instance of a Python list.
page_size	An int trait.
password	A trait for unicode strings.
product	An enum whose value must be in a given sequence.
quality_flag_key
short_name
source
style	A trait whose value must be an instance of a specified class.
time_key	A trait for unicode strings.
token	A trait for unicode strings.
udims
udims_overwrite	An instance of a Python list.
units	A trait for unicode strings.
updated_since	A trait for unicode strings.
username	A trait for unicode strings.
version

Members:

__init__(**kwargs)

Do not overwrite me

append_file(all_data, data)

Append data

Parameters:

• all_data (podpac.UnitsDataArray) – aggregated data

• data (podpac.UnitsDataArray) – new data to append

Raises:

NotImplementedError –

base_url

A trait for unicode strings.

check_quality_flags

A boolean (True, False) trait.

property coverage

data_key

A trait for unicode strings.

property lat_key

property lon_key

min_bounds_span

An instance of a Python dict.

One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.

Changed in version 5.0: Added key_trait for validating dict keys.

Changed in version 5.0: Deprecated ambiguous trait, traits args in favor of value_trait, per_key_traits.

nan_vals = [-9999.0]

product

An enum whose value must be in a given sequence.

property quality_flag_key

read_file(filelike)

Interpret individual SMAP file from EGI zip archive.

Parameters:

filelike (filelike) – Reference to file inside EGI zip archive

Return type:

podpac.UnitsDataArray

Raises:

ValueError –

property short_name

property udims

property version