/erddapy

Python interface for ERDDAP

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

erddapy: ERDDAP + Python.

conda-forge downloads Latest version Commits since last release # contributors zenodo zenodo pre-commit.ci status GHA-tests


Table of contents

Overview

Easier access to scientific data.

erddapy takes advantage of ERDDAP's RESTful web services and creates the ERDDAP URL for any request, like searching for datasets, acquiring metadata, downloading the data, etc.

What is ERDDAP? ERDDAP unifies the different types of data servers and offers a consistent way to get the data in multiple the formats. For more information on ERDDAP servers please see https://coastwatch.pfeg.noaa.gov/erddap/index.html.

Documentation and code

The documentation is hosted at https://ioos.github.io/erddapy.

The code is hosted at https://github.com/ioos/erddapy.

Installation

For conda users you can

conda install --channel conda-forge erddapy

or, if you are a pip users

python -m pip install erddapy

Note that, if you are installing the requirements-dev.txt, the iris package is named scitools-iris on PyPI so pip users must rename that before installing.

Example

from erddapy import ERDDAP


e = ERDDAP(
  server="https://gliders.ioos.us/erddap",
  protocol="tabledap",
)

e.response = "csv"
e.dataset_id = "whoi_406-20160902T1700"
e.constraints = {
    "time>=": "2016-07-10T00:00:00Z",
    "time<=": "2017-02-10T00:00:00Z",
    "latitude>=": 38.0,
    "latitude<=": 41.0,
    "longitude>=": -72.0,
    "longitude<=": -69.0,
}
e.variables = [
    "depth",
    "latitude",
    "longitude",
    "salinity",
    "temperature",
    "time",
]

df = e.to_pandas()

Get in touch

Report bugs, suggest features or view the source code on GitHub.

Projects using erddapy

Similar projects

  • rerddap implements a nice client for R that performs searches on a curated set of servers instead of a query per server like erddapy.

  • erddap-python 99% of the same functionality as erddapy but with a JavaScript-like API.

License and copyright

Erddapy is licensed under BSD 3-Clause "New" or "Revised" License (BSD-3-Clause).

Development occurs on GitHub at https://github.com/ioos/erddapy.