BoM Water

A python tool for requesting data from BoM Sensor Observation Service (SOS2, as WaterML 2.0 format)

This package has been developed to access to the BoM Water Data Sensor Observation Service (SOS) with a goal to easily and efficiently integrate data into scientific workflows

License

MIT-derived (see License.txt)

Installation

From pypi:

pip install pybomwater

From source:

• Using poetry
  • I like to keep the .venv in my project directory so I use poetry config --local virtualenvs.in-project true
  • poetry install which will install the dependencies listed in the poetry.lock
  • poetry shell which is initialize the environment within your running application (eg cmd), or in VS Code Cmd+Shift+p and then type Python Interpreter and select the environment you just built.

Usage

see Jupyter Notebook example

NOTE

The first time a BomWater object is instantiated (bm = bom_water.BomWater()) a cache of data is created. This process obtains data from the BoM service and will take a little while to complete. Once cached this process is not repeated and performance will return to normal.

Running tests

By default, pytest skips tests that call the live BoM SOS service. To run those integration tests explicitly:

PYBOMWATER_RUN_LIVE=1 pytest -m live_bom

The progressive observation load test is gated separately. It makes five increasingly large requests, stops immediately on HTTP 429, and prints timings, response sizes, observation counts, and any rate-limit headers:

PYBOMWATER_RUN_LOAD=1 pytest -m load_bom -s

The companion notebook test is also gated separately. It clones bomwater-notebook into a temporary directory and executes every notebook against the current pybomwater checkout. Install its optional runtime and run it with:

python -m pip install -r requirements-notebooks.txt

PYBOMWATER_RUN_NOTEBOOKS=1 pytest -m notebook_bom -s

Documentation

Bureau of Meteorology (BoM) documentation on using their SOS service is available at the following links:

• BoM Water Data service
• BoM Notes
• BoM Guide to Sensor Observation Services (SOS2)

The following cells implement requests that access the BoM SOS2 service.

GetCapabilties

Lists services available and the filters that can be used to select data output by those services. It also provides an overview of parameters, time series types and geographic area covered by the services.

GetFeatureOfInterest

Provides details about a set of geographical features or locations at which observations are measured. They can be selected according to the parameter measured, type of time series available, and area or point location.

GetDataAvailability

Lists the type of data available for a ‘feature of interest’ and its coverage. This includes a list of parameters, the time series types available for each of the parameters, and the observed period of record for each time series type.

GetObservation

Returns observations of a specified ‘feature of interest’ and parameter, within a specific time series type. Each observation has a datetime, value, quality and interpolation type.

Parameter currently available via SOS2

Timeseries pattern and aggreated available

Task list