The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

How to use erddapy

instantiate the ERDDAP server

First of all, we need to instantiate the ERDDAP URL constructor for a server.

server: an ERDDAP server URL or an acronym for one of the builtin servers.

from erddapy import ERDDAP
import pandas as pd
e = ERDDAP(server="https://erddap.bcdc.no/erddap")

Let’s explore the methods and attributes available in the ERDDAP object
Note: All the methods prefixed with get_ will return a valid ERDDAP URL for the requested response and options.

[method for method in dir(e) if not method.startswith("_")]

['auth', 'constraints', 'dataset_id', 'get_categorize_url', 'get_download_url', 'get_info_url', 'get_search_url', 'get_var_by_attr', 'protocol', 'relative_constraints', 'requests_kwargs', 'response', 'server', 'server_functions', 'to_iris', 'to_ncCF', 'to_pandas', 'to_xarray', 'variables']

help(e.get_search_url)

Help on method get_search_url in module erddapy.erddapy:

get_search_url(response: Union[str, NoneType] = None, search_for: Union[str, NoneType] = None, protocol: Union[str, NoneType] = None, items_per_page: int = 1000, page: int = 1, **kwargs) -> str method of erddapy.erddapy.ERDDAP instance
The search URL for the `server` endpoint provided.

Args:
search_for: "Google-like" search of the datasets' metadata.
- Type the words you want to search for, with spaces between the words.
ERDDAP will search for the words separately, not as a phrase.

- To search for a phrase, put double quotes around the phrase (for example, `"wind speed"`).

- To exclude datasets with a specific word, use `-excludedWord`.

- To exclude datasets with a specific phrase, use `-"excluded phrase"`

- Searches are not case-sensitive.

- You can search for any part of a word. For example, searching for `spee` will find datasets with `speed` and datasets with `WindSpeed`

- The last word in a phrase may be a partial word. For example, to find datasets from a specific website (usually the start of the datasetID), include (for example) `"datasetID=erd"` in your search.

response: default is HTML.

items_per_page: how many items per page in the return, default is 1000.

page: which page to display, default is the first page (1).

kwargs: extra search constraints based on metadata and/or coordinates ke/value.
metadata: `cdm_data_type`, `institution`, `ioos_category`, `keywords`, `long_name`, `standard_name`, and `variableName`.

coordinates: `minLon`, `maxLon`, `minLat`, `maxLat`, `minTime`, and `maxTime`.

Returns:
url: the search URL.