Skip to main content

Your Ocean Data Access in Python

Project description

[![Build Status](https://travis-ci.org/cormorack/yodapy.svg?branch=master)](https://travis-ci.org/cormorack/yodapy)
[![Build status](https://ci.appveyor.com/api/projects/status/29rvgs6u8t552ui2?svg=true)](https://ci.appveyor.com/project/lsetiawan/yodapy)
[![Coverage Status](https://coveralls.io/repos/github/cormorack/yodapy/badge.svg?branch=master)](https://coveralls.io/github/cormorack/yodapy?branch=master)
[![CodeFactor](https://www.codefactor.io/repository/github/cormorack/yodapy/badge/master)](https://www.codefactor.io/repository/github/cormorack/yodapy/overview/master)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
# yodapy
Your Ocean Data Access in Python (YODAPY)

## Installation

```bash
pip install yodapy
```

## Development
```bash
git clone https://github.com/cormorack/yodapy.git
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 .
```

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

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

## Example running the program

```python
>>> from yodapy.datasources import OOI
>>> ooi = OOI()
>>> ooi.search(region='cabled', site='axial base shallow profiler', node='shallow profiler', instrument='CTD')
>>> ooi.view_instruments()
reference_designator name start_depth end_depth current_status preferred_stream preferred_parameter location
1287 RS03AXPS-SF03A-2A-CTDPFA302 CTD 5.0 200.0 ctdpf_sbe43_sample 908 Shallow Profiler
>>> ooi.data_availability()
{'RS03AXPS-SF03A-2A-CTDPFA302': [{'stream': 'ctdpf_sbe43_sample',
'method': 'streamed',
'count': 110547881,
'endTime': '2018-07-02T22:11:19.511Z',
'beginTime': '2014-10-07T21:32:53.602Z'}]}
>>> 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()
>>> ds_list
[<xarray.Dataset>
Dimensions: (time: 86398)
...]
```




Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
yodapy-0.2.2b0-py3-none-any.whl (109.1 kB) Copy SHA256 hash SHA256 Wheel py3 Jul 31, 2018
yodapy-0.2.2b0.tar.gz (111.7 kB) Copy SHA256 hash SHA256 Source None Jul 31, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page