The Python Client Library provides easy access to the Oceans 2.0 Web API by providing a class that hides the complexity of consuming ONC's web services. The class methods provided by this package allow to request and download ONC data and files using a single line of code.
- Getting started
- The ONC class
- Discovery methods
- Data product download methods
- Near real-time data access methods
- Archive file download methods
- Utility methods
- Code examples
Search for available locations, deployments, device categories, devices, properties, and data products (documentation).
|Returns a filtered list of locations||link|
|Returns a filtered tree of locations with their children||link|
|Returns a filtered list of deployments||link|
|Returns a filtered list of device categories||link|
|Returns a filtered list of devices||link|
|Returns a filtered list of properties||link|
|Returns a filtered list of data products||link|
Data product download methods
|Request, run and download a data product||link|
|Request a data product||link|
|Run a data product request||link|
|Download an available data product||link|
Near real-time data access methods
Extract sensor data as time-series, either as processed scalar data or as raw data directly from the device (documentation).
|Obtain scalar data readings from a device category in a location||link|
|Obtain scalar data readings from a device||link|
|Obtain raw data readings from a device category in a location||link|
|Obtain raw data readings from a device||link|
Archive file download methods
Download previously generated data product files from our archive (documentation).
|Get a list of archived files for a device category in a location||link|
|Get a list of archived files for a device||link|
|Download a file with the given filename||link|
|Download a list of archived files that match the filters provided||link|
Methods included as convenience shortcuts for end users. (documentation).
|Prints a dictionary in a format easier to read||link|
|Formats the provided date string to meet ISO8601||link|
The latest library version works with the current version of Oceans 2.0 Web API.
New versions are created to resolve known client library issues, add new functionality or handle changes to the underlying Web Services.
Please report all issues with the web services, documentation and client libraries to the Oceans 2.0 Help Centre.