hdpws 0.1

Synopsis

This library provides a simple python interface to NASA's Heliophysics Data Portal (HDP). This library implements the client side of the HDP RESTful web services. For more general details about the HDP web services, see https://heliophysicsdata.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 hdpws

This "Getting Started" page contains information to help someone begin using the hdpws library to access information from the Heliophysics Data Portal in a Python program.

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

1. Simple Query Example (ipynb file)demonstrating a simple query.

These notebooks are also available on Binder.

Motivation

This library hides the HTTP and JSON/XML details of the HDP web services. A python developer only has to deal with python objects and methods.

Dependencies

At this time, the only dependency are:

1. requests

The critical dependencies above will automatically be installed when this library is.

Installation

To install this package

$ pip install -U hdpws

API Reference

Refer to hdpws package API reference

or use the standard python help mechanism.

from hdpws import HdpWs
help(HdpWs)

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).