Skip to main content

NASA's Coordinated Data Analysis System Web Service Client Library

Project description

Synopsis

This library provides a simple python interface to the data and services of NASA's Coordinated Data Analysis System (CDAS). This library implements the client side of the CDAS RESTful web services and can return data in the SpacePy data model or an xarray.Dataset with all the original ISTP/SPDF metadata. Frequently asked questions concerning this library are at FAQ. For more general details about the CDAS web services, see https://cdaweb.gsfc.nasa.gov/WebServices/REST/.

Code Example

This package contains example code calling most of the available web services. To run the included example, do the following

python -m cdasws

Also, the following Jupyter notebook demonstrate different features of the library:

  1. Example (ipynb file) demonstrating use of library.

And at the bottom of each CDAWeb dataset description is a "Data Access Code Examples" link that contains dataset-specific code utilizing this package to access the data.

Motivation

This library hides the HTTP, JSON/XML, and CDF details of the CDAS web services. A python developer only has to deal with python objects and methods (primarily the SpacePy data model or xarray.Dataset object with full ISTP/SPDF metadata).

Dependencies

The only required dependencies are python-dateutil and requests. If you call the get_data method then one of the following two sets of additional dependencies are required:

  1. To have get_data return the data in the SpacePy data model.
    • SpacePy. Refer to the SpacePy documentation for the details of SpacePy's dependencies.
    • CDF which is not (at the time of this writing) automatically installed with SpacePy.
  2. To have get_data return the data in an xarray dataset.

Installation

As noted in the dependencies above, if you intend to call the get_data method, you must install either

  1. SpacePy and the CDF library (following the procedures at the SpacePy and CDF web sites).
  2. cdflib. $ pip install -U cdflib

Then, to install this package

$ pip install -U cdasws

API Reference

Refer to cdasws package API reference

or use the standard python help mechanism.

from cdasws import CdasWs
help(CdasWs)

Tests

The tests directory contains unittest tests.

Contributors

Bernie Harris.
e-mail for support.

License

This code is licensed under the NASA Open Source Agreement (NOSA).

Project details


Download files

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

Source Distribution

cdasws-1.7.37.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

cdasws-1.7.37-py3-none-any.whl (37.6 kB view details)

Uploaded Python 3

File details

Details for the file cdasws-1.7.37.tar.gz.

File metadata

  • Download URL: cdasws-1.7.37.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.12

File hashes

Hashes for cdasws-1.7.37.tar.gz
Algorithm Hash digest
SHA256 04208473049f769712081fa6ebbc9ea86c81bba352e36d726c4fa5fc40471f08
MD5 490778215fbdc08ea5e7be7d5476f73d
BLAKE2b-256 3ce35405e8a86113da0d807ad9a10872b9f920936e94c6b1d0b5c47ed48ec2d3

See more details on using hashes here.

File details

Details for the file cdasws-1.7.37-py3-none-any.whl.

File metadata

  • Download URL: cdasws-1.7.37-py3-none-any.whl
  • Upload date:
  • Size: 37.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.12

File hashes

Hashes for cdasws-1.7.37-py3-none-any.whl
Algorithm Hash digest
SHA256 4251d6a29e1b0f18878fc8f2e631b54af53a351c06aa2fcf2b12aa5dbdbbff24
MD5 8573f265bcc17ec4be875b109676656d
BLAKE2b-256 9e13642fee94a54a16f35e0810a3d9f5889e40e94e1fe8210c1e612649f6e389

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page