forked from https://github.com/jmunroe/intake-erddap.
Intake-ERDDAP
Copyright 2022 Axiom Data Science
See LICENSE
Copyright 2022 James Munroe
For changes prior to 2022-10-19, all contributions are Copyright James Munroe, see PREV-LICENSE.
Check out our Read The Docs page for additional documentation
Intake is a lightweight set of tools for loading and sharing data in data science projects. Intake ERDDAP provides a set of integrations for ERDDAP.
- Quickly identify all datasets from an ERDDAP service in a geographic region, or containing certain variables.
- Produce a pandas DataFrame for a given dataset or query.
- Get an xarray Dataset for the Gridded datasets.
The key features are:
- Pandas DataFrames for any TableDAP dataset.
- xarray Datasets for any GridDAP datasets.
- Query by any or all:
- bounding box
- time
- CF
standard_name - variable name
- Plaintext Search term
- Save catalogs locally for future use.
User Installation
In the very near future, we will be offering the project on conda. Currently the
project is available on PyPI, so it can be installed using pip
pip install intake-erddap
Developer Installation
Prerequisites
The following are prerequisites for a developer environment for this project:
Note: if mamba isn't installed, replace all instances of mamba in the following instructions with conda.
-
Create the project environment with:
mamba env update -f environment.yml -
Install the development environment dependencies:
mamba env update -f dev-environment.yml -
Activate the new virtual environment:
conda activate intake-erddap -
Install the project to the virtual environment:
pip install -e .
Note that you need to install with pip install . once to get the entry_points correct too.
Examples
To create an intake catalog for all of the ERDDAP's TableDAP offerings use:
import intake_erddap
catalog = intake_erddap.ERDDAPCatalogReader(
server="https://erddap.sensors.ioos.us/erddap"
).read()
The catalog objects behave like a dictionary with the keys representing the dataset's unique identifier within ERDDAP, and the values being the TableDAPReader objects. To access a Reader object (for a single dataset, in this case for dataset_id "aoos_204"):
dataset = catalog["aoos_204"]
From the reader object, a pandas DataFrame can be retrieved:
df = dataset.read()
Find other dataset_ids available with
list(catalog)
Consider a case where you need to find all wind data near Florida:
import intake_erddap
from datetime import datetime
bbox = (-87.84, 24.05, -77.11, 31.27)
catalog = intake_erddap.ERDDAPCatalogReader(
server="https://erddap.sensors.ioos.us/erddap",
bbox=bbox,
intersection="union",
start_time=datetime(2022, 1, 1),
end_time=datetime(2023, 1, 1),
standard_names=["wind_speed", "wind_from_direction"],
variables=["wind_speed", "wind_from_direction"],
).read()
dataset_id = list(catalog)[0]
print(dataset_id)
df = catalog[dataset_id].read()
Using the standard_names input with intersection="union" searches for datasets that have both "wind_speed" and "wind_from_direction". Using the variables input subsequently narrows the dataset to only those columns, plus "time", "latitude", "longitude", and "z".
time (UTC) latitude (degrees_north) ... wind_speed (m.s-1) wind_from_direction (degrees)
0 2022-01-01T00:00:00Z 28.508 ... 3.6 126.0
1 2022-01-01T00:10:00Z 28.508 ... 3.8 126.0
2 2022-01-01T00:20:00Z 28.508 ... 3.6 124.0
3 2022-01-01T00:30:00Z 28.508 ... 3.4 125.0
4 2022-01-01T00:40:00Z 28.508 ... 3.5 124.0
... ... ... ... ... ...
52524 2022-12-31T23:20:00Z 28.508 ... 5.9 176.0
52525 2022-12-31T23:30:00Z 28.508 ... 6.8 177.0
52526 2022-12-31T23:40:00Z 28.508 ... 7.2 175.0
52527 2022-12-31T23:50:00Z 28.508 ... 7.4 169.0
52528 2023-01-01T00:00:00Z 28.508 ... 8.1 171.0
[52529 rows x 6 columns]
Metadata
Release files for intake-erddap 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| intake_erddap-0.5.2.tar.gz | 40.8 kB | Without provenance | Details for intake_erddap-0.5.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| intake_erddap-0.5.2-py3-none-any.whl | Python 3 | none | any | Details for intake_erddap-0.5.2-py3-none-any.whl |
Total release size: 59.1 kB
Release files / intake_erddap-0.5.2.tar.gz
| Download URL | intake_erddap-0.5.2.tar.gz |
|---|---|
| Size | 40.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd602cf55bb5e67630a359ee27cfd967a844b184dda6292f7ecbf5f8558f52d6
|
|
BLAKE2b-256 checksum How to use checksums |
983c2d150fc92cc47ac095e8f6e6f275a61e7f8f3b702ebca4f13e7b9e434419
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / intake_erddap-0.5.2-py3-none-any.whl
| Download URL | intake_erddap-0.5.2-py3-none-any.whl |
|---|---|
| Size | 18.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e682363e516174655350ba23d7096847a906ca300fd900f2251e5c5720129ff6
|
|
BLAKE2b-256 checksum How to use checksums |
c4ef4cb27c1653fb6843e72b47c8679bc8f5b67cf6a2b4cc785ac1a4efeb907e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Security for intake-erddap 0.5.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.