Date: Fri, 29 Mar 2024 07:48:47 +0000 (UTC) Message-ID: <211540311.21.1711698527217@dcconf.dc.onc> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_20_1804434095.1711698527214" ------=_Part_20_1804434095.1711698527214 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The Oceans 3.0 API provides programmatic access to the over 500 = terabytes of data collected since 2006, from thousands of sensors, through = a collection of web services. This Guide describes how to use the Ocean 3.0= API to write scripts in any language that supports HTTP requests, or use o= ur sample code or one of our client libraries to shortcut the development p= rocess.
The Oceans 3.0 API provides a collection of web services for programmati= cally unlocking access to the vast ONC data archive, whether it is scalar d= ata, complex data or video and imagery. The services in the API are split i= nto three functional groups: 1) Discovery, 2) Delivery and 3) Inter= operability.
1) The discovery services are a collection of five services which are used to obtain all= of the codes needed to successfully request data from the ONC data archive= .
2) The data product delivery services are a collection = of three services that return data defined by filter criteria. The d= ata delivery services are split into two functional groups based on their d= elivery method: a) Asynchronous for large volumes or resampled data, and b)= Synchronous for simple, near real-time scalar and raw data.
a) The asynchronous approach is handled b= y the dataProductsDelivery web service, which provi= des programmatic and url access to all the same data and data products as a= re available in the Oceans 3.0 Data Search web application. Data Pro= ducts can be requested from instruments in five different ways, to suit dif= ferent user workflows:
Because it is built on top of the Data Pr= oducts framework, whenever new data products are made available or existing= data products are improved, they are automatically made be available throu= gh the API.
All of the same data product functionalit= y, including quality control, sub-sampling, multiple file formats and more,= can be requested through the API. With a new JSON data product, 'Time Seri= es Scalar Data' products can be easily ingested into a program, in your pro= gramming language of choice, for further processing and analysis.
b) The synchronous approach is currently = being handled by the scalardata and rawdata services. The objective of these services is to provide fast access to small amoun= ts of simple data, such as the last reading from an instrument and return i= t immediately in the response payload in json format, so that it can be qui= ckly utilized by the calling program.
If you are a Python, MATLAB or R programmer, you can quickly start using= the Oceans 3.0 API, by taking advantage of our client libraries. This guid= e will take you step-by-step through getting setup, writing code and retrie= ving data.
For more information about getting started, see our API_Sandbox_Demo_August_= 2018public.pdf
Client libraries provide quick, easy and consistent access to Oceans 3.0 API, in popular scientific programming languages.
These libraries provide a class w= ith methods that wrap web service calls, complex workflows, and business lo= gic so that users can discover and download data (raw, text, image, audio, = video or any other available) in a single line of code.
They are all free projects, publi= shed under Open Source licenses:
Language | Latest library version | Repository | License | Code Repository in github | |
---|---|---|---|---|---|
|
Python |
2.3.5 (12/12/2019) |
PyPI | Apache 2 | python-client= (20/03/2024) |
|
MATLAB |
|
File Exchange= | BSD 2 | matlab-client= |
|
R |
|
Github | MIT | r-client |
If this is your first time using these client libraries, we suggest you vi=
sit the Installation and&n=
bsp;Getting started pages.
New versions are created to resolve known client library issues, add new= functionality or handle changes to the underlying Web Services.
Please repor=
t all issues with the web services, documentation, samples and client libra=
ries by going to Oceans 3.0 Data Portal and clicking