Skip to main content

Your Ocean Data Access in Python

Project description

Build Status Build status Coverage Status CodeFactor License: MIT


Your Ocean Data Access in Python (YODAPY)


pip install yodapy

Install directly from github

For developers and testers:

pip install git+


git clone
cd yodapy
conda create -n yodapy -c conda-forge --yes python=3.6 --file requirements.txt --file requirements-dev.txt
source activate yodapy
pip install -e .


To obtain credentials you are obliged to register at the OOI data portal. Select the Log In dropdown and click Register. Fill out and submit the form and you will automatically be logged in. Click on your email ID (upper right) to visit/edit your profile. This profile now includes your credentials. You should click on the button Refresh API Token to get a stable token; and then make a note of both your username (format OOIAPI-XXXXXXXXXXXXXX) and your token (format XXXXXXXXXXX). They are used in what follows.

To start using yodapy for the ooi datasource, you will need to setup your credential file. This will only need be set one time.

>>> from yodapy.utils.creds import set_credentials_file
>>> set_credentials_file(data_source='ooi', username='MyName', token='My secret token')

Example running the program

>>> from yodapy.datasources import OOI
>>> ooi = OOI()
>>>'cabled', site='axial base shallow profiler', node='shallow profiler', instrument='CTD')
>>> ooi.view_instruments()
>>> ooi.data_availability()
>>> begin_date = '2018-01-01'
>>> end_date = '2018-01-02'
>>> ooi.request_data(begin_date=begin_date, end_date=end_date)
>>> ooi.check_status()
Request Completed
>>> ds_list = ooi.to_xarray()

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for yodapy, version 0.3.0b0
Filename, size File type Python version Upload date Hashes
Filename, size yodapy-0.3.0b0-py3-none-any.whl (134.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size yodapy-0.3.0b0.tar.gz (135.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page