## 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 from any of
[these datasets](https://cdaweb.gsfc.nasa.gov/misc/Notes.html) in a
[SpacePy datamodel](https://spacepy.github.io/datamodel.html),
[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html), or
[pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html)
with all source and
[ISTP/SPDF](https://spdf.gsfc.nasa.gov/sp_use_of_cdf.html) metadata.
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. [Data Retrieval](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsDataRetrieval.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsDataRetrieval.ipynb)) demonstrating use of library with results returned in [SpacePy data model](https://spacepy.github.io/datamodel.html), [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html), and [pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html). [Launch on Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsDataRetrieval.ipynb).
2. [CDAWeb Binning Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsBinningExample.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsBinningExample.ipynb)) demonstrating use [CDAWeb binning](https://cdaweb.gsfc.nasa.gov/CDAWeb_Binning_readme.html). [Launch on Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsBinningExample.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://binder.opensci.2i2c.cloud/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](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html) or [pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html).
* [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": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"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/76/b3/2a2ed2be55d2e29196bb25aa46fe22ca4544c45707d1f546742353674b19/cdasws-1.8.9.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 from any of \n[these datasets](https://cdaweb.gsfc.nasa.gov/misc/Notes.html) in a \n[SpacePy datamodel](https://spacepy.github.io/datamodel.html),\n[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html), or\n[pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html)\nwith all source and \n[ISTP/SPDF](https://spdf.gsfc.nasa.gov/sp_use_of_cdf.html) metadata.\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. [Data Retrieval](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsDataRetrieval.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsDataRetrieval.ipynb)) demonstrating use of library with results returned in [SpacePy data model](https://spacepy.github.io/datamodel.html), [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html), and [pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html). [Launch on Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsDataRetrieval.ipynb).\n2. [CDAWeb Binning Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsBinningExample.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsBinningExample.ipynb)) demonstrating use [CDAWeb binning](https://cdaweb.gsfc.nasa.gov/CDAWeb_Binning_readme.html). [Launch on Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsBinningExample.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://binder.opensci.2i2c.cloud/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](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html) or [pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html).\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.8.9",
"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": "984e30685a794a1ff4c9af8a8c5c76dafb5d04fe4659c3b527db5f1a8e907f30",
"md5": "a3113a1a1325da8cfde981cdfd401eb0",
"sha256": "4d0e39e17978a7855ae8d1a8bc1ee50ac8098a94d02a5e0da79c2875cab2d531"
},
"downloads": -1,
"filename": "cdasws-1.8.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a3113a1a1325da8cfde981cdfd401eb0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 43459,
"upload_time": "2024-12-05T14:05:15",
"upload_time_iso_8601": "2024-12-05T14:05:15.746995Z",
"url": "https://files.pythonhosted.org/packages/98/4e/30685a794a1ff4c9af8a8c5c76dafb5d04fe4659c3b527db5f1a8e907f30/cdasws-1.8.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76b32a2ed2be55d2e29196bb25aa46fe22ca4544c45707d1f546742353674b19",
"md5": "239054b39e2bc1e61e30bfdfbd3acc80",
"sha256": "f2eb51d24855c38a4e4a861889643f0438d1ff14be8c81780674286e58e4fcd0"
},
"downloads": -1,
"filename": "cdasws-1.8.9.tar.gz",
"has_sig": false,
"md5_digest": "239054b39e2bc1e61e30bfdfbd3acc80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26172,
"upload_time": "2024-12-05T14:05:17",
"upload_time_iso_8601": "2024-12-05T14:05:17.373407Z",
"url": "https://files.pythonhosted.org/packages/76/b3/2a2ed2be55d2e29196bb25aa46fe22ca4544c45707d1f546742353674b19/cdasws-1.8.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-05 14:05:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cdasws"
}
JSON