Skip to main content

Heliophysics API

Project description


Operating system command line:

pip install hapiclient --upgrade


pip install --upgrade

See the Appendix for a fail-safe installation method.

Basic Example

# Get and plot Dst index from CDAWeb HAPI server
from hapiclient import hapi
from hapiclient import hapiplot

server     = ''
dataset    = 'OMNI2_H0_MRG1HR'
start      = '2003-09-01T00:00:00'
stop       = '2003-12-01T00:00:00'
parameters = 'DST1800'
opts       = {'logging': True}

# Get data
data, meta = hapi(server, dataset, parameters, start, stop, **opts)

# Plot all parameters
hapiplot(data, meta)


All of the features are extensively demonstrated in the hapi_demo.ipynb Jupyter Notebook. The notebook shows example usage of the functions in this package that can be copied into a script or onto a Python command line.

To view the help string on the Python command line after installing hapiclient using pip install hapiclient, use

from hapiclient import hapi


from hapiclient import hapiplot


git clone
cd client-python; python develop

(The command python develop creates symlinks so that the local package is used instead of an installed package. Use pip uninstall hapiclient to ensure the local package is used.)

To run tests before a commit, execute

make repository-test

To run an individual unit test in a Python session, use, e.g.,

from hapiclient.test.test_hapi import test_reader


Submit bug reports and feature requests on the repository issue tracker.

Bob Weigel


Fail-safe installation

Python command line:

import os
print(os.popen("pip install hapiclient").read())

The above executes and displays the output of the operating system command pip install hapiclient using the shell environment associated with that installation of Python.

This method addresses a problem that is sometimes encountered when attempting to use pip packages in Anaconda. To use a pip package in Anaconda, one must use the version of pip installed with Anaconda (it is usually under a subdirectory with the name anaconda/) as opposed to the one installed with the operating system. To see the location of pip used in a given Python session, enter print(os.popen("which pip").read()).

Project details

Download files

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

Files for hapiclient, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size hapiclient-0.1.2.tar.gz (45.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page