API reference

collections(; keyword=value, ...) -> Vector{Collections.UMM_C}

Search for collections using NASA EarthData Search. Possible keywords are (:concept_id, :doi, :echo_collection_id, :provider_short_name, :entry_title, :entry_id, :archive_center, :data_center, :temporal, :project, :consortium, :updated_since, :created_at, :has_granules_created_at, :has_granules_revised_at, :revision_date, :processing_level_id, :platform, :instrument, :sensor, :spatial_keyword, :science_keywords, :two_d_coordinate_system_name, :collection_data_type, :granule_data_format, :online_only, :downloadable, :browsable, :keyword, :provider, :native_id, :short_name, :version, :tag_key, :variable_name, :variable_native_id, :variable_concept_id, :variables, :service_name, :service_type, :service_concept_id, :tool_name, :tool_type, :tool_concept_id, :polygon, :bounding_box, :point, :line, :circle, :attribute, :author, :has_granules, :has_granules_or_cwic, :has_granules_or_opensearch, :has_opendap_url, :cloud_hosted, :standard_product, :sort_key, :all_revisions) or (:page_size, :page_num, :offset, :scroll, :sort_key, :pretty, :token, :echo_compatible).

granules(; keyword=value, ...) -> Vector{Granules.UMM_G}

Search for granules using NASA EarthDataSearch. Possible keywords are (:collection_concept_id, :granule_ur, :readable_granule_name, :online_only, :downloadable, :browsable, :attribute, :polygon, :equator_crossing_longitude, :equator_crossing_date, :updated_since, :revision_date, :created_at, :production_date, :cloud_cover, :platform, :instrument, :sensor, :project, :concept_id, :echo_granule_id, :echo_collection_id, :day_night_flag, :two_d_coordinate_system, :provider, :native_id, :short_name, :version, :entry_title, :entry_id, :temporal, :cycle, :passes, :sort_key) or (:page_size, :page_num, :offset, :scroll, :sort_key, :pretty, :token, :echo_compatible).

g = first(granules(short_name="GEDI02_A"))
startswith(sprint(show, g), "GEDI02_A: ")
# output
true

netrc!(username, password)

Writes/updates a .netrc file for ICESat-2 and GEDI downloads. A .netrc is a plaintext file containing your username and password for NASA EarthData and DAACs, and can be automatically used by Julia using Downloads and tools like wget, curl among others.

CollectionRequest(; keyword=value, ...)

As documented by https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#collection-search-by-parameters.

GranuleRequest(; keyword=value, ...)

As documented by https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#granule-search-by-parameters. See fieldnames(GranuleRequest) for a list of all possible keywords.

Information about any physical constraints for accessing the data set.

A reference to an additional attribute in the parent collection. The attribute reference may contain a granule specific value that will override the value in the parent collection for this granule. An attribute with the same name must exist in the parent collection.

A boundary is set of points connected by straight lines representing a polygon on the earth. It takes a minimum of three points to make a boundary. Points must be specified in counter-clockwise order and closed (the first and last vertices are the same).

This entity holds the horizontal spatial coverage of a bounding box.

This entity is used to reference characteristics defined in the parent collection.

Allows the provider to provide a checksum value and checksum algorithm name to allow the user to calculate the checksum.

A reference to a collection metadata record's short name and version, or entry title to which this granule metadata record belongs.

This entity stores the basic descriptive characteristics associated with a granule.

Contains the excluded boundaries from the GPolygon.

This set of elements describes a file package or a file that contains other files. Normally this is either a tar or a zip file.

This set of elements describes a file. The file can be a part of the entire granule or is the granule.

A GPolygon specifies an area on the earth represented by a main boundary with optional boundaries for regions excluded from the main boundary.

This entity holds the geometry representing the spatial coverage information of a granule.

Information about a granule with horizontal spatial coverage.

This entity stores an identifier. If the identifier is part of the enumeration then use it. If the enumeration is 'Other', the provider must specify the identifier's name.

A reference to the device in the parent collection that was used to measure or record data, including direct human observation. In cases where instruments have a single composed of child instrument (sensor) or the instrument and composed of child instrument (sensor) are used synonymously (e.g. AVHRR) the both Instrument and composed of child instrument should be recorded. The child instrument information is represented by child entities. The instrument reference may contain granule specific characteristics and operation modes. These characteristics and modes are not checked against the referenced instrument.

This entity holds the horizontal spatial coverage of a line. A line area contains at lease two points.

This entity contains the name of the geophysical parameter expressed in the data as well as associated quality flags and quality statistics. The quality statistics element contains measures of quality for the granule. The parameters used to set these measures are not preset and will be determined by the data producer. Each set of measures can occur many times either for the granule as a whole or for individual parameters. The quality flags contain the science, operational and automatic quality flags which indicate the overall quality assurance levels of specific parameter values within a granule.

This object requires any metadata record that is validated by this schema to provide information about the schema.

This entity is used to store the characteristics of the orbit calculated spatial domain to include the model name, orbit number, start and stop orbit number, equator crossing date and time, and equator crossing longitude.

This entity stores orbital coverage information of the granule. This coverage is an alternative way of expressing granule spatial coverage. This information supports orbital backtrack searching on a granule.

This entity stores basic descriptive characteristics related to the Product Generation Executable associated with a granule.

A reference to a platform in the parent collection that is associated with the acquisition of the granule. The platform must exist in the parent collection. For example, Platform types may include (but are not limited to): ADEOS-II, AEM-2, Terra, Aqua, Aura, BALLOONS, BUOYS, C-130, DEM, DMSP-F1,etc.

The longitude and latitude values of a spatially referenced point in degrees.

Information describing the scientific endeavor with which the granule is associated.

Specifies the date and its type that the provider uses for the granule. For Create, Update, and Insert the date is the date that the granule file is created, updated, or inserted into the provider database by the provider. Delete is the date that the CMR should delete the granule metadata record from its repository.

The quality flags contain the science, operational and automatic quality flags which indicate the overall quality assurance levels of specific parameter values within a granule.

The quality statistics element contains measures of quality for the granule. The parameters used to set these measures are not preset and will be determined by the data producer. Each set of measures can occur many times either for the granule as a whole or for individual parameters.

Stores the data acquisition start and end date/time for a granule.

This entity holds all types of online URL associated with the granule such as guide document or ordering site etc.

This class contains attributes which describe the spatial extent of a granule. Spatial Extent includes any or all of Granule Localities, Horizontal Spatial Domain, and Vertical Spatial Domain.

Information which describes the temporal extent of a specific granule.

Defines the minimum and maximum value for one dimension of a two dimensional coordinate system.

This entity stores the tiling identification system for the granule. The tiling identification system information is an alternative way to express granule's spatial coverage based on a certain two dimensional coordinate system defined by the providers. The name must match the name in the parent collection.

This element stores a track pass and its tile information. It will allow a user to search by pass number and their tiles that are contained with in a cycle number. While trying to keep this generic for all to use, this comes from a SWOT requirement where a pass represents a 1/2 orbit. This element will then hold a list of 1/2 orbits and their tiles that together represent the granules spatial extent.

This element stores track information of the granule. Track information is used to allow a user to search for granules whose spatial extent is based on an orbital cycle, pass, and tile mapping. Though it is derived from the SWOT mission requirements, it is intended that this element type be generic enough so that other missions can make use of it. While track information is a type of spatial domain, it is expected that the metadata provider will provide geometry information that matches the spatial extent of the track information.

This entity contains the type and value for the granule's vertical spatial domain.

Information about any constraints for accessing the data set. This includes any special restrictions, legal prerequisites, limitations and/or warnings on obtaining the data set.

Additional unique attributes of the collection, beyond those defined in the UMM model, which the data provider deems useful for end-user understanding of the data in the collection. Additional attributes are also called Product Specific Attributes (PSAs) or non-core attributes. Examples are HORIZONTALTILENUMBER, VERTICALTILENUMBER.

This entity contains the physical address details for the contact.

The reference frame or system from which altitude is measured. The term 'altitude' is used instead of the common term 'elevation' to conform to the terminology in Federal Information Processing Standards 70-1 and 173. The information contains the datum name, distance units and encoding method, which provide the definition for the system.

This element and all of its sub elements exist for display purposes. It allows a data provider to provide archive and distribution information up front to an end user, to help them decide if they can use the product.

This element stores the DOI (Digital Object Identifier) that identifies the collection. Note: The values should start with the directory indicator which in ESDIS' case is 10. If the DOI was registered through ESDIS, the beginning of the string should be 10.5067. The DOI URL is not stored here; it should be stored as a RelatedURL. The DOI organization that is responsible for creating the DOI is described in the Authority element. For ESDIS records the value of https://doi.org/ should be used. NASA metadata providers are strongly encouraged to include DOI and DOI Authority for their collections using CollectionDOI property.

A boundary is set of points connected by straight lines representing a polygon on the earth. It takes a minimum of three points to make a boundary. Points must be specified in counter-clockwise order and closed (the first and last vertices are the same).

This entity is used to define characteristics.

Defines the contact information of a data center or data contact.

Method for contacting the data contact. A contact can be available via phone, email, Facebook, or Twitter.

Defines a data center which is either an organization or institution responsible for distributing, archiving, or processing the data, etc.

Specifies the date and its type.

The reference frame or system from which depth is measured. The information contains the datum name, distance units and encoding method, which provide the definition for the system.

This element allows end users to get direct access to data products that are stored in the Amazon Web Service (AWS) S3 buckets. The sub elements include S3 credentials end point and a documentation URL as well as bucket prefix names and an AWS region.

Formerly called Internal Directory Name (IDN) Node (IDN_Node). This element has been used historically by the GCMD internally to identify association, responsibility and/or ownership of the dataset, service or supplemental information. Note: This field only occurs in the DIF. When a DIF record is retrieved in the ECHO10 or ISO 19115 formats, this element will not be translated.

This element stores the DOI (Digital Object Identifier) that identifies the collection. Note: The values should start with the directory indicator which in ESDIS' case is 10. If the DOI was registered through ESDIS, the beginning of the string should be 10.5067. The DOI URL is not stored here; it should be stored as a RelatedURL. The DOI organization that is responsible for creating the DOI is described in the Authority element. For ESDIS records the value of https://doi.org/ should be used. NASA metadata providers are strongly encouraged to include DOI and DOI Authority for their collections using CollectionDOI property.

Contains the excluded boundaries from the GPolygon.

The largest width of an instrument's footprint as measured on the Earths surface. The largest Footprint takes the place of SwathWidth in the Orbit Backtrack Algorithm if SwathWidth does not exist. The optional description element allows the user of the record to be able to distinguish between the different footprints of an instrument if it has more than 1.

This element describes the geodetic model for the data product.

Represents the information needed for a DistributionURL where data is retrieved.

Represents a Service through a URL where the service will act on data and return the result to the caller.

Generic Resolutions object describes general resolution data for a data product where it is not known if a data product is gridded or not.

Gridded Range Resolutions object describes range resolution data for gridded data products.

Gridded Resolutions object describes resolution data for gridded data products.

Non Gridded Range Resolutions object describes range resolution data for non gridded data products.

Non Gridded Resolutions object describes resolution data for non gridded data products.

This class defines a number of the data products horizontal data resolution. The horizontal data resolution is defined as the smallest horizontal distance between successive elements of data in a dataset. This is synonymous with terms such as ground sample distance, sample spacing and pixel size. It is to be noted that the horizontal data resolution could be different in the two horizontal dimensions. Also, it is different from the spatial resolution of an instrument, which is the minimum distance between points that an instrument can see as distinct.

Information about a collection with horizontal spatial coverage.

Child object on an instrument. Has all the same fields as instrument, minus the list of child instruments.

Information about the device used to measure or record data in this collection, including direct human observation. In cases where instruments have a single child instrument or the instrument and child instrument are used synonymously (e.g. AVHRR), both Instrument and ComposedOf should be recorded. The child instrument information is represented in a separate section. The controlled vocabulary for instrument names is maintained in the Keyword Management System (KMS).

This element defines a hierarchical location list. It replaces SpatialKeywords. The controlled vocabulary for location keywords is maintained in the Keyword Management System (KMS). Each tier must have data in the tier above it.

Used to identify other services, collections, visualizations, granules, and other metadata types and resources that are associated with or dependent on this collection, including parent-child relationships.

This object requires any metadata record that is validated by this schema to provide information about the schema.

Describes the online resource pertaining to the data.

Orbit parameters for the collection used by the Orbital Backtrack Algorithm.

For paleoclimate or geologic data, PaleoTemporalCoverage is the length of time represented by the data collected. PaleoTemporalCoverage should be used when the data spans time frames earlier than yyyy-mm-dd = 0001-01-01.

Information about Periodic Date Time collections, including the name of the temporal period in addition to the start and end dates, duration unit and value, and cycle duration unit and value.

Describes the relevant platforms used to acquire the data in the collection. The controlled vocabularies for platform types and names are maintained in the Keyword Management System (KMS).

The longitude and latitude values of a spatially referenced point in degrees.

This element contains the Processing Level Id and the Processing Level Description

Information describing the scientific endeavor(s) with which the collection is associated. Scientific endeavors include campaigns, projects, interdisciplinary science investigations, missions, field experiments, etc. The controlled vocabularies for project names are maintained in the Keyword Management System (KMS)

Describes key bibliographic citations pertaining to the data.

Stores the start and end date/time of a collection.

Represents Internet sites that contain information related to the data, as well as related Internet sites such as project home pages, related data archives/servers, metadata extensions, online software packages, web mapping services, and calibration/validation data.

This class defines the horizontal spatial extents coordinate system and the data product's horizontal data resolution. The horizontal data resolution is defined as the smallest horizontal distance between successive elements of data in a dataset. This is synonymous with terms such as ground sample distance, sample spacing and pixel size. It is to be noted that the horizontal data resolution could be different in the two horizontal dimensions. Also, it is different from the spatial resolution of an instrument, which is the minimum distance between points that an instrument can see as distinct.

Building block text fields used to construct the recommended language for citing the collection in professional scientific literature. The citation language constructed from these fields references the collection itself, and is not designed for listing bibliographic references of scientific research articles arising from search results. A list of references related to the research results should be in the Publication Reference element.

Enables specification of Earth science keywords related to the collection. The controlled vocabulary for Science Keywords is maintained in the Keyword Management System (KMS).

Specifies the geographic and vertical (altitude, depth) coverage of the data.

This entity stores the reference frame or system from which horizontal and vertical spatial domains are measured. The horizontal reference frame includes a Geodetic Model, Geographic Coordinates, and Local Coordinates. The Vertical reference frame includes altitudes (elevations) and depths.

Information which describes the temporal range or extent of a specific collection.

Defines the minimum and maximum value for one dimension of a two dimensional coordinate system.

Information about a two-dimensional tiling system related to this collection.

This sub-element either contains a license summary or free-text description that details the permitted use or limitation of this collection.

This element defines how the data may or may not be used after access is granted to assure the protection of privacy or intellectual property. This includes license text, license URL, or any special restrictions, legal prerequisites, terms and conditions, and/or limitations on using the data set. Data providers may request acknowledgement of the data from users and claim no responsibility for quality and completeness of data.