A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Ocean Networks Canada

Provides easy access to Ocean Networks Canada data in Python.
https://github.com/oceannetworkscanada/api-python-client

Category: Hydrosphere
Sub Category: Ocean and Hydrology Data Access

Keywords

api data-science ocean-sciences onc python

Keywords from Contributors

archiving transforms measur generic optimize observation compose conversion projection animals

Last synced: about 2 hours ago
JSON representation

Repository metadata

Provides easy access to ONC data in Python

README.md

onc: client library for accessing Oceans 3.0 API

PyPI Latest Release
PyPI Supported Versions
License - Apache 2.0
Frontiers in Marine Science Paper

onc is a Python client library that facilitates access to scientific data hosted by Ocean Networks Canada
through the Oceans 3.0 API public web services.
It can help you explore and download our data, by consuming our
discovery,
data product download,
archive file download, and
near real-time data access services.

Getting Started

Installation

onc can be installed from PyPI:

pip install onc

Obtaining a token

A unique Oceans 3.0 API token is required to access our data.
To obtain a token, follow the steps below:

  1. Register for an Oceans 3.0 account at https://data.oceannetworks.ca/Registration.

  2. Log into your account at https://data.oceannetworks.ca by clicking the Log In link.

  3. Click the Profile link (top right corner) to access your account profile.

  4. Access the Web Services API tab and click Copy Token.

  5. If you forget your token, you can always find it again in your Oceans 3.0 account profile.

Searching with discovery methods

To download ONC data, you need to specify the type of data you require
and where in particular (i.e. location, device) it originates from.

In the Oceans 3.0 API, there's a unique code that identifies every location, device, property, data product type, etc.
Include these codes in a group of filters (these will be used as URL parameters when making HTTP requests)
that determine the data you're interested in.

Discovery methods allow you to explore the hierarchy of the ONC database to obtain the codes for your filters
(they work like a "search" function).

The example below uses the getLocations method to search for locations that include "Burrard" in their name (i.e. "Burrard Inlet"):

from onc import ONC

onc = ONC("YOUR_TOKEN")

onc.getLocations({"locationName": "Burrard"})

The previous code prints a list with locations that match the search filters provided.
Each location in the list includes a dataSearchURL that points to the Data Search Tool,
and a locationCode ("BIPP" and "BISS" in this example) that can be used to continue searching "inside" it,
as in the following example:

onc.getDeviceCategories({"locationCode": "BIIP"})
onc.getDataProducts({"locationCode": "BIIP", "deviceCategoryCode": "CTD"})

Check more on the discovery methods guide
and code examples.

Downloading data products

Once you determine the exact dictionary of filters that identifies the data you are interested in,
there are multiple methods to download it.

One method is to request the ONC servers to generate a custom data product with the data.
This is done through the data product download methods.

The following example downloads two PNG files with plots for 30 seconds of data from a CTD in Campbell River:

params = {
    "locationCode": "BIIP",
    "deviceCategoryCode": "CTD",
    "dataProductCode": "TSSP",
    "extension": "png",
    "dateFrom": "2019-06-20T00:00:00.000Z",
    "dateTo": "2019-06-20T00:30:00.000Z",
    "dpo_qualityControl": "1",
    "dpo_resample": "none",
}
onc.orderDataProduct(params, includeMetadataFile=False)

The filters above include codes for location, deviceCategory, and dataProduct,
as well as the file extension and a time interval (in UTC).
They also include a couple of filters to configure this specific data product type (starting with the "dpo_" prefix),
which can be obtained from the Data Product Options documentation.
You can download more than 120 different types of data products including audio & video.

Check more on the data product download methods guide
and code examples.

Obtaining sensor readings in (near) real-time

Another method to obtain ONC data is by directly obtaining a time series of sensor readings
(available as soon as they reach our database).

In the following example, we obtain 5 seconds of conductivity readings from the CTD at Burrard Inlet:

params = {
    "locationCode": "BIIP",
    "deviceCategoryCode": "CTD",
    "propertyCode": "conductivity",
    "dateFrom": "2019-06-20T00:00:00.000Z",
    "dateTo": "2019-06-20T00:00:05.000Z",
}
onc.getScalardata(params)

# Longer method name
# onc.getScalardataByLocation(params)

The result includes matching lists of "values" and "sampleTimes" (increases performance for long time ranges).
We also use the property code "conductivity" to limit results to a specific property available in this CTD.

Check more on the near real-time data access methods guide
and code examples.

Downloading archived files

ONC scripts auto-generate and archive data products of different types at set time intervals.
You can directly download these data product files from our files archive, as long as you know their unique filename.

In the following example, we get a list of archived files available for a camera at Ridley Island (in a certain time span),
and download one of the files:

params = {
    "locationCode": "RISS",
    "deviceCategoryCode": "VIDEOCAM",
    "dateFrom": "2016-12-01T00:00:00.000Z",
    "dateTo": "2016-12-01T00:05:00.000Z",
}
result = onc.getArchivefile(params, allPages=True)

# Longer method name
# result = onc.getArchivefileByLocation(params, allPages=True)

# Download one of the files from result["files"]
onc.downloadArchivefile("AXISQ6044PTZACCC8E334C53_20161201T000001.000Z.jpg", overwrite=True)

You can use the method downloadArchivefile() as above to download individual files or the method downloadDirectArchivefile()
to download all the files that match your filters.

Alternatively, if you prefer using a download manager like aria2 or Free Download Manager, getArchivefileUrls and getArchivefileUrl can return the download URLs of the archivefile
without downloading the files.

Check more on the archive file download methods guide
and code examples.

Documentation

The client library documentation is hosted on GitHub Pages.
For documentation and examples about Oceans 3.0 API, visit the wiki
and OpenAPI page on the Oceans 3.0 Data Portal website.

Multithreading issue

We kindly ask users to not use too many threads when using threading/multiprocessing libraries on download tasks.
It can cause issues for both server and client and may not appreciably increase download speeds.

Contributing

All contributions are welcome and appreciated!
Please refer to the Contributing guide before submitting any issues or pull requests.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 5 days ago

Total Commits: 95
Total Committers: 6
Avg Commits per committer: 15.833
Development Distribution Score (DDS): 0.347

Commits in past year: 43
Committers in past year: 2
Avg Commits per committer in past year: 21.5
Development Distribution Score (DDS) in past year: 0.023

Name Email Commits
Kan Fu f****u@g****m 62
Dany Cabrera d****a@u****a 18
Jake 3****s 9
Renfu Li r****i@o****m 4
dependabot[bot] 4****] 1
Spencer Plovie 6****e 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 27
Total pull requests: 34
Average time to close issues: 4 months
Average time to close pull requests: 9 days
Total issue authors: 3
Total pull request authors: 4
Average comments per issue: 0.96
Average comments per pull request: 1.26
Merged pull request: 32
Bot issues: 0
Bot pull requests: 1

Past year issues: 5
Past year pull requests: 20
Past year average time to close issues: 24 days
Past year average time to close pull requests: 4 days
Past year issue authors: 2
Past year pull request authors: 2
Past year average comments per issue: 2.6
Past year average comments per pull request: 0.05
Past year merged pull request: 20
Past year bot issues: 0
Past year bot pull requests: 1

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/oceannetworkscanada/api-python-client

Top Issue Authors

  • kan-fu (20)
  • Jacob-Stevens-Haas (6)
  • aschlesin (1)

Top Pull Request Authors

  • kan-fu (29)
  • Renfu-Li (2)
  • Jacob-Stevens-Haas (2)
  • dependabot[bot] (1)

Top Issue Labels

  • enhancement (10)
  • documentation (3)
  • backend (3)
  • bug (3)
  • Internal (2)

Top Pull Request Labels

  • dependencies (1)

Package metadata

pypi.org: onc

Oceans 3.0 API Python Client Library

  • Homepage: https://data.oceannetworks.ca/OpenAPI
  • Documentation: https://oceannetworkscanada.github.io/api-python-client/
  • Licenses: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright 2019-2025 Ocean Networks Canada Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  • Latest release: 2.5.0 (published 2 months ago)
  • Last Synced: 2025-04-26T12:32:27.030Z (1 day ago)
  • Versions: 39
  • Dependent Packages: 2
  • Dependent Repositories: 4
  • Downloads: 2,197 Last month
  • Rankings:
    • Dependent packages count: 4.787%
    • Average: 7.068%
    • Dependent repos count: 7.484%
    • Downloads: 8.934%
  • Maintainers (4)

Dependencies

pyproject.toml pypi
  • humanize *
  • python-dateutil *
  • requests *
.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite

Score: 12.381520633380957