Data Retrieval Methods

The methods below can be used to retrieve metadata and to query, subset, and colocalize datasets. To begin, you must create an instance of the pycmap API. This tutorial can be found below.

API	Create an Instance of the API
Query	Generic SQL Query
Catalog	Retrieve Catalog
Search Catalog	Search Catalog by Keyword
Datasets	Retrieve List of Datasets
Metadata	Retrieve Variable Metadata
Dataset Metadata	Retrieve Dataset Metadata
Dataset Columns	Retrieve Column Names
Dataset Head	Retrieve Top Rows of Given Dataset
Variable Long Name	Returns Long Name of Given Variable
Variable Unit	Returns Unit for Given Variable, if applicable
Variable Resolution	Returns Spatial and Temporal Resolution of Given Variable
Variable Coverage	Returns Spatial and Temporal Coverage of Given Variable
Variable Stat	Returns Summary Statistics for Given Variable
If Column Exists	Returns True if Column Exists
Is Gridded Product	Returns True if Variable is Gridded Product
Is Climatology Product	Returns True if Dataset is Climatology Product
List of Cruises	Returns Cruise Expedition Details
Cruise Details by Name	Returns Cruise Specific Details by Name
Cruise Spatio-Temporal Bounds	Returns Cruise Spatio-Temporal Bounds
Cruise Trajectory	Returns Trajectory for Specific Cruise
Cruise Variables	Returns Variables Associated with Specific Cruise
Retrieve Dataset	Returns the Entire Dataset
Data Subset: Generic Space-Time Cut	Returns a Subset of Data Defined by Space and Time
Data Subset: Time Series	Returns a Subset of Data Aggregated by Time
Data Subset: Depth Profile	Returns a Subset of Data Aggregated by Depth
Match (colocalize) Datasets	Colocalizes Variables between Datasets
Match (colocalize) Cruise Track with Datasets	Colocalizes Variables along Cruise Trajectory