## Synopsis
This library provides a simple python interface to
NASA's [Heliophysics Data Portal's](https://heliophysicsdata.gsfc.nasa.gov/)
(HDP) Space Physics Archive, Search, and Extract
([SPASE](https://spase-group.org/)) Web Service. This library implements
the client side of the
[HDP RESTful web services](https://heliophysicsdata.gsfc.nasa.gov/WebServices/).
For more general details about the HDP web services, see
https://heliophysicsdata.gsfc.nasa.gov/WebServices/.
## 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
---
Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
different features of the library:
1. [Simple Query Example](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.html) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.ipynb)) demonstrating a simple query. [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExample.ipynb).
2. [Example with data retrieval](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.html) using [cdasws](https://pypi.org/project/cdasws/) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.ipynb)). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExampleWithCdasWs.ipynb).
## 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](https://pypi.org/project/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](https://heliophysicsdata.gsfc.nasa.gov/WebServices/py/hdpws/index.html)
or use the standard python help mechanism.
from hdpws import HdpWs
help(HdpWs)
## Tests
The tests directory contains
[unittest](https://docs.python.org/3/library/unittest.html)
tests.
## Contributors
Bernie Harris.
[e-mail](mailto:NASA-SPDF-Support@nasa.onmicrosoft.com) for support.
## License
This code is licensed under the
[NASA Open Source Agreement](https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
Raw data
{
"_id": null,
"home_page": "https://heliophysicsdata.gsfc.nasa.gov/WebServices",
"name": "hdpws",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "heliophysics, spase, space physics, spdf, hdp",
"author": "Bernie Harris",
"author_email": "NASA-SPDF-Support@nasa.onmicrosoft.com",
"download_url": "https://files.pythonhosted.org/packages/f7/92/102435cacdda1d634f83a56bae5c5af332ddb245f2e8601e6bdcb26010c4/hdpws-0.6.23.tar.gz",
"platform": null,
"description": "\n## Synopsis\n\nThis library provides a simple python interface to \nNASA's [Heliophysics Data Portal's](https://heliophysicsdata.gsfc.nasa.gov/)\n(HDP) Space Physics Archive, Search, and Extract \n([SPASE](https://spase-group.org/)) Web Service. This library implements \nthe client side of the \n[HDP RESTful web services](https://heliophysicsdata.gsfc.nasa.gov/WebServices/).\nFor more general details about the HDP web services, see\nhttps://heliophysicsdata.gsfc.nasa.gov/WebServices/.\n\n\n## Code Example\n\nThis package contains example code calling most of the available web services.\nTo run the included example, do the following\n\n python -m hdpws\n\n---\n\nAlso, the following [Jupyter notebooks](https://jupyter.org/) demonstrate\ndifferent features of the library:\n1. [Simple Query Example](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.html) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.ipynb)) demonstrating a simple query. [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExample.ipynb).\n2. [Example with data retrieval](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.html) using [cdasws](https://pypi.org/project/cdasws/) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.ipynb)). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExampleWithCdasWs.ipynb).\n\n\n## Motivation\n\nThis library hides the HTTP and JSON/XML details of the HDP web \nservices. A python developer only has to deal with python objects and \nmethods.\n\n## Dependencies\n\nAt this time, the only dependency are:\n1. [requests](https://pypi.org/project/requests/)\n\nThe critical dependencies above will automatically be installed when this \nlibrary is.\n\n## Installation\n\nTo install this package\n\n $ pip install -U hdpws\n\n## API Reference\n\nRefer to\n[hdpws package API reference](https://heliophysicsdata.gsfc.nasa.gov/WebServices/py/hdpws/index.html)\n\nor use the standard python help mechanism.\n\n from hdpws import HdpWs\n help(HdpWs)\n\n## Tests\n\nThe tests directory contains \n[unittest](https://docs.python.org/3/library/unittest.html)\ntests.\n\n## Contributors\n\nBernie Harris. \n[e-mail](mailto:NASA-SPDF-Support@nasa.onmicrosoft.com) for support.\n\n## License\n\nThis code is licensed under the \n[NASA Open Source Agreement](https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).\n",
"bugtrack_url": null,
"license": "NOSA",
"summary": "NASA's Heliophysics Data Portal Web Service Client Library",
"version": "0.6.23",
"project_urls": {
"Homepage": "https://heliophysicsdata.gsfc.nasa.gov/WebServices"
},
"split_keywords": [
"heliophysics",
" spase",
" space physics",
" spdf",
" hdp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94b10f8f1d4855ca9044cdd0d8ae96988706dcc7e8c1ec5e586a4a053ccbb2cf",
"md5": "47bdb205e971f0c1ce94f01ddd6f1e34",
"sha256": "f97907d86c98c2d94a61a6c89065908f8442afadce1aaa751d512da170153a44"
},
"downloads": -1,
"filename": "hdpws-0.6.23-py3-none-any.whl",
"has_sig": false,
"md5_digest": "47bdb205e971f0c1ce94f01ddd6f1e34",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23035,
"upload_time": "2024-03-20T14:31:14",
"upload_time_iso_8601": "2024-03-20T14:31:14.567768Z",
"url": "https://files.pythonhosted.org/packages/94/b1/0f8f1d4855ca9044cdd0d8ae96988706dcc7e8c1ec5e586a4a053ccbb2cf/hdpws-0.6.23-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f792102435cacdda1d634f83a56bae5c5af332ddb245f2e8601e6bdcb26010c4",
"md5": "6d6da4168db340fbf97dbdd079a2482e",
"sha256": "c90e68b53a88210a096d3e741318c09eb576eb09703ab73deda6db85b1c68299"
},
"downloads": -1,
"filename": "hdpws-0.6.23.tar.gz",
"has_sig": false,
"md5_digest": "6d6da4168db340fbf97dbdd079a2482e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24451,
"upload_time": "2024-03-20T14:31:16",
"upload_time_iso_8601": "2024-03-20T14:31:16.373196Z",
"url": "https://files.pythonhosted.org/packages/f7/92/102435cacdda1d634f83a56bae5c5af332ddb245f2e8601e6bdcb26010c4/hdpws-0.6.23.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-20 14:31:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "hdpws"
}
JSON