# Python 2.7 and 3 compatible
# Report software bugs/issues/feature requests at
# https://github.com/hapi-server/client-python/issues
# Report data server issues to undefined

# Install latest hapiclient package from https://pypi.org/project/hapiclient/
# Only needs to be executed once.
import os; print(os.popen('pip install hapiclient --upgrade').read())

from hapiclient import hapi

server     = 'https://imag-data.bgs.ac.uk/GIN_V1/hapi'
dataset    = 'bou/definitive/PT1M/xyzf'
# Notes:
# 1. Use parameters='' to request all parameters from bou/definitive/PT1M/xyzf.
# 2. Multiple parameters can be requested using a comma-separated
#    list, e.g., parameters='Field_Vector,Field_Magnitude'
parameters = 'Field_Vector'
start      = '1991-01-01T00:00:00Z' # min 1991-01-01T00:00:00Z
stop       = '1991-01-03T00:00:00.000Z' # max 2022-12-31T23:59:00Z

data, meta = hapi(server, dataset, parameters, start, stop)

import os; print(os.popen('pip install hapiplot --upgrade').read())
from hapiplot import hapiplot
hapiplot(data, meta)

# Notes:
# 1. To convert ISO 8601 strings the primary time parameter to Python
#    datetimes, use
#      from hapiclient import hapitime2datetime
#      time_name = meta["parameters"][0]["name"] # Primary time parameter is always first.
#      Time = hapitime2datetime(data[time_name])
# 2. Details about the data and metadata structures `data`
#    and `meta` are given at 
#    https://github.com/hapi-server/client-python-notebooks/blob/master/hapi_demo.ipynb
# 3. Many examples for using `data` and `meta` with other
#    Python libraries (e.g., Pandas, Numpy, Astropy) are given
#    in above-referenced notebook.