NOAA

Query and parsing functions for the NOAA Tides and Currents webservices API

Calling Sequence

import pyTMD.io
stations = pyTMD.io.NOAA.prediction_stations()

Source code

pyTMD.io.NOAA.build_query(api: str, **kwargs)[source]

Build a query for the NOAA webservices API

Parameters:

api: str: NOAA webservices API endpoint to query
kwargs: dict: Additional query parameters to include in the request

Returns:

url: str: Complete URL for API request
namespaces: dict: Namespaces for parsing XML responses

pyTMD.io.NOAA.build_stylesheet(namespaces: dict, key: str = 'wsdl', **kwargs)[source]

Build an XSLT stylesheet to flatten NOAA webservices API responses

Parameters:

namespaces: dict: Namespaces for parsing XML responses
key: str, default “wsdl”: Key for namespace to use in stylesheet

Returns:

stylesheet: StringIO: file-like object for XSLT stylesheet

pyTMD.io.NOAA.from_xml(url: str, **kwargs)[source]

Query the NOAA webservices API and return as a DataFrame

Parameters:

url: str: The complete URL for the API request
kwargs: dict: Additional keyword arguments to pass to pandas.read_xml

Returns:

df: pandas.DataFrame: Data from NOAA webservices

pyTMD.io.NOAA.prediction_stations(api: str = 'tidepredictionstations', active_only: bool = True, **kwargs)[source]

Retrieve a list of tide prediction stations

Parameters:

api: str: NOAA webservices API endpoint to query
active_only: bool, default True: Reduce list to active stations only
kwargs: dict: Additional query parameters to include in the request

Returns:

df: pandas.DataFrame: Table of tide prediction stations

pyTMD.io.NOAA.active_stations(api: str = 'activestations', **kwargs)[source]

Retrieve a list of active tide stations

Parameters:

api: str: NOAA webservices API endpoint to query
kwargs: dict: Additional query parameters to include in the request

Returns:

df: pandas.DataFrame: Table of currently active stations

pyTMD.io.NOAA.harmonic_constituents(api: str = 'harmonicconstituents', **kwargs)[source]

Retrieve a list of harmonic constituents for a specified station

Parameters:

api: str: NOAA webservices API endpoint to query
kwargs: dict: Additional query parameters to include in the request

Returns:

df: pandas.DataFrame: Table of tide constituents

pyTMD.io.NOAA.water_level(api: str = 'waterlevelrawsixmin', **kwargs)[source]

Retrieve water level data for a specified station and date range

Parameters:

api: str: NOAA webservices API endpoint to query
kwargs: dict: Additional query parameters to include in the request

Returns:

df: pandas.DataFrame: Table of water level data

class pyTMD.io.NOAA.DataFrame(df)[source]

Accessor for extending an pandas.DataFrame for tide models

to_dataset()[source]

Convert NOAA constituent Dataframe to an xarray.Dataset

Returns:

ds: xarray.Dataset: Tide constituent Dataset