## Synopsis
This library provides a simple python interface to the heliophysics data
and services of
NASA's [Coordinated Data Analysis System](https://cdaweb.gsfc.nasa.gov/)
(CDAS). This library implements the client side of the
[CDAS RESTful web services](https://cdaweb.gsfc.nasa.gov/WebServices/REST/)
and can return data in the
[SpacePy data model](https://spacepy.github.io/datamodel.html) or an
[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html)
with all the original
[ISTP/SPDF metadata](https://spdf.gsfc.nasa.gov/sp_use_of_cdf.html).
Frequently asked questions concerning this library are at
[FAQ](https://cdaweb.gsfc.nasa.gov/WebServices/REST/py/FAQ.html).
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 notebooks](https://jupyter.org/) demonstrate
different features of the library:
1. [Basic Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExample.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExample.ipynb)) demonstrating use of library with results returned in [SpacePy data model](https://spacepy.github.io/datamodel.html). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsExample.ipynb).
2. [Basic Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExampleXarray.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExampleXarray.ipynb)) demonstrating use of library with results returned in an [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsExampleXarray.ipynb).
3. [Magnetic Field Line Conjunction Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.ipynb)) with related data retrieval/plotting using [cdasws](https://pypi.org/project/cdasws/). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/sscws-notebooks/main?labpath=SscWsConjunctionExample.ipynb).
---
And at the bottom of each
[CDAWeb dataset description](https://cdaweb.gsfc.nasa.gov/misc/Notes.html)
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](https://spacepy.github.io/). Refer to the SpacePy
documentation for the details of SpacePy's dependencies.
2. To have get_data return the data in an xarray dataset.
* [cdflib](https://pypi.org/project/cdflib/).
* [xarray](https://pypi.org/project/xarray/).
## Installation
As noted in the dependencies above, if you intend to call the get_data
method, you must install **one** of the following options.
1. [SpacePy](https://spacepy.github.io/).
$ pip install -U spacepy
2. [cdflib](https://pypi.org/project/cdflib/) and [xarray](https://pypi.org/project/xarray/).
$ pip install -U cdflib
$ pip install -U xarray
Then, to install this package
$ pip install -U cdasws
## API Reference
Refer to
[cdasws package API reference](https://cdaweb.gsfc.nasa.gov/WebServices/REST/py/cdasws/index.html)
or use the standard python help mechanism.
from cdasws import CdasWs
help(CdasWs)
## 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://cdaweb.gsfc.nasa.gov/WebServices/REST",
"name": "cdasws",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "heliophysics,coordinated data analysis,multi-mission,multi-instrument,space physics,spdf,cdaweb",
"author": "Bernie Harris",
"author_email": "NASA-SPDF-Support@nasa.onmicrosoft.com",
"download_url": "https://files.pythonhosted.org/packages/83/25/7873b63cfc61c08c8f03a3e6dc58685ace91ffba15c65882dc60f70a3e08/cdasws-1.7.46.tar.gz",
"platform": null,
"description": "\n## Synopsis\n\nThis library provides a simple python interface to the heliophysics data \nand services of \nNASA's [Coordinated Data Analysis System](https://cdaweb.gsfc.nasa.gov/)\n(CDAS). This library implements the client side of the \n[CDAS RESTful web services](https://cdaweb.gsfc.nasa.gov/WebServices/REST/)\nand can return data in the \n[SpacePy data model](https://spacepy.github.io/datamodel.html) or an\n[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html)\nwith all the original \n[ISTP/SPDF metadata](https://spdf.gsfc.nasa.gov/sp_use_of_cdf.html).\nFrequently asked questions concerning this library are at \n[FAQ](https://cdaweb.gsfc.nasa.gov/WebServices/REST/py/FAQ.html).\nFor more general details about the CDAS web services, see\nhttps://cdaweb.gsfc.nasa.gov/WebServices/REST/.\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 cdasws\n\n---\nAlso, the following [Jupyter notebooks](https://jupyter.org/) demonstrate\ndifferent features of the library:\n\n1. [Basic Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExample.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExample.ipynb)) demonstrating use of library with results returned in [SpacePy data model](https://spacepy.github.io/datamodel.html). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsExample.ipynb).\n2. [Basic Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExampleXarray.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExampleXarray.ipynb)) demonstrating use of library with results returned in an [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsExampleXarray.ipynb).\n3. [Magnetic Field Line Conjunction Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.ipynb)) with related data retrieval/plotting using [cdasws](https://pypi.org/project/cdasws/). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/sscws-notebooks/main?labpath=SscWsConjunctionExample.ipynb).\n---\n\nAnd at the bottom of each \n[CDAWeb dataset description](https://cdaweb.gsfc.nasa.gov/misc/Notes.html) \nis a \"Data Access Code Examples\" link that contains dataset-specific code \nutilizing this package to access the data.\n\n## Motivation\n\nThis library hides the HTTP, JSON/XML, and CDF details of the CDAS web \nservices. A python developer only has to deal with python objects and \nmethods (primarily the SpacePy data model or xarray.Dataset object with \nfull ISTP/SPDF metadata).\n\n## Dependencies\n\nThe only required dependencies are python-dateutil and requests. If you\ncall the get_data method then **one** of the following two sets of additional\ndependencies are required:\n\n1. To have get_data return the data in the SpacePy data model.\n * [SpacePy](https://spacepy.github.io/). Refer to the SpacePy\n documentation for the details of SpacePy's dependencies.\n2. To have get_data return the data in an xarray dataset.\n * [cdflib](https://pypi.org/project/cdflib/).\n * [xarray](https://pypi.org/project/xarray/).\n\n## Installation\n\nAs noted in the dependencies above, if you intend to call the get_data\nmethod, you must install **one** of the following options.\n\n1. [SpacePy](https://spacepy.github.io/).\n\n $ pip install -U spacepy\n\n2. [cdflib](https://pypi.org/project/cdflib/) and [xarray](https://pypi.org/project/xarray/).\n\n $ pip install -U cdflib\n $ pip install -U xarray\n\nThen, to install this package\n\n $ pip install -U cdasws\n\n\n## API Reference\n\nRefer to\n[cdasws package API reference](https://cdaweb.gsfc.nasa.gov/WebServices/REST/py/cdasws/index.html)\n\nor use the standard python help mechanism.\n\n from cdasws import CdasWs\n help(CdasWs)\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\n\n",
"bugtrack_url": null,
"license": "NOSA",
"summary": "NASA's Coordinated Data Analysis System Web Service Client Library",
"version": "1.7.46",
"project_urls": {
"Homepage": "https://cdaweb.gsfc.nasa.gov/WebServices/REST"
},
"split_keywords": [
"heliophysics",
"coordinated data analysis",
"multi-mission",
"multi-instrument",
"space physics",
"spdf",
"cdaweb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4dcf37f7b82c2780571aab7daa8d8761bd0a6bdbcccaba1ea4324abc16f593f8",
"md5": "7c0359fca25ac1ba41b9dba9b0031a96",
"sha256": "4be69ae9cd61213d1f9b72d731f429408e831a1f4fdf732b36b183bb8bef12d8"
},
"downloads": -1,
"filename": "cdasws-1.7.46-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c0359fca25ac1ba41b9dba9b0031a96",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 39151,
"upload_time": "2024-03-13T18:25:57",
"upload_time_iso_8601": "2024-03-13T18:25:57.921674Z",
"url": "https://files.pythonhosted.org/packages/4d/cf/37f7b82c2780571aab7daa8d8761bd0a6bdbcccaba1ea4324abc16f593f8/cdasws-1.7.46-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83257873b63cfc61c08c8f03a3e6dc58685ace91ffba15c65882dc60f70a3e08",
"md5": "245e4978c7743910b2b5786bd278f322",
"sha256": "3dfd518e7f55ba155c107880ac63c6066f4c2ac2a5663cba36c4574cdc1ec766"
},
"downloads": -1,
"filename": "cdasws-1.7.46.tar.gz",
"has_sig": false,
"md5_digest": "245e4978c7743910b2b5786bd278f322",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22035,
"upload_time": "2024-03-13T18:25:59",
"upload_time_iso_8601": "2024-03-13T18:25:59.499023Z",
"url": "https://files.pythonhosted.org/packages/83/25/7873b63cfc61c08c8f03a3e6dc58685ace91ffba15c65882dc60f70a3e08/cdasws-1.7.46.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 18:25:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cdasws"
}
JSON