dea_tools.bom

Loading and processing Australian Bureau of Meteorology data.

License: The code in this notebook is licensed under the Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0). Digital Earth Australia data is licensed under the Creative Commons by Attribution 4.0 license (https://creativecommons.org/licenses/by/4.0/).

Contact: If you need assistance, please post a question on the Open Data Cube Slack channel (http://slack.opendatacube.org/) or on the GIS Stack Exchange (https://gis.stackexchange.com/questions/ask?tags=open-data-cube) using the open-data-cube tag (you can view previously asked questions here: https://gis.stackexchange.com/questions/tagged/open-data-cube).

If you would like to report an issue with this script, you can file one on Github (GeoscienceAustralia/dea-notebooks#new).

Last modified: March 2021

Functions

get_station_data(station[, time, ...])

Query Gauge Data.

get_stations([time, observation, url])

Get list of stations

mk_station_selector(on_select[, stations, ...])

Add stations to the map and register on_click event.

ui_select_station(stations[, zoom, center])

Create an interactive map for selecting river gauging stations.

dea_tools.bom.get_station_data(station, time=None, observation='http://bom.gov.au/waterdata/services/parameters/Water Course Discharge', url='http://www.bom.gov.au/waterdata/services')[source]

Query Gauge Data.

Parameters:
  • station – One of the stations see get_stations

  • time – tuple of datetime.datetime objects, or None to query from 1980-1-1 to Now

Return type:

Pandas dataframe with Timestamp(index), Value columns

dea_tools.bom.get_stations(time=None, observation='http://bom.gov.au/waterdata/services/parameters/Water Course Discharge', url='http://www.bom.gov.au/waterdata/services')[source]

Get list of stations

Parameters:

time – tuple of datetime.datetime objects, or None to query from 1980-1-1 to Now

Returns:

.name – string, human readable station name .pos – Coordinate of the station or None .url – service url identifier

Return type:

List of stations

dea_tools.bom.mk_station_selector(on_select, stations=None, dst_map=None, **kw)[source]

Add stations to the map and register on_click event.

Parameters:
  • on_select – Will be called when user selects station on the map on_select(station)

  • stations – List of stations as returned from get_stations

  • dst_map – Map to add stations markers to

Any other arguments are passed on to Map(..) constructor.

Returns:

  • (map, marker_cluster)

  • Passes through map=dst_map if not None, or returns newly constructed Map object.

dea_tools.bom.ui_select_station(stations, zoom=3, center=(-24, 138), **kw)[source]

Create an interactive map for selecting river gauging stations.