## Synopsis
This library provides a simple python interface to
NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
(SSC). This library implements the client side of the
[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/).
For more general details about the SSC web services, see
https://sscweb.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 sscws
---
This
["Getting Started"](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/GetStarted.html)
page contains information to help someone begin using the sscws library to
access information from the
[Satellite Situation Center](https://sscweb.gsfc.nasa.gov/) in a Python program.
---
Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
different features of the library:
1. [Simple Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.ipynb))demonstrating a simple 3D plot of orbit information.
2. [Complex Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsBTraceExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsBTraceExample.ipynb)) requesting many values including magnetic field line tracing. This example also demonstrates how to diagnose a problem with an invalid request.
3. [Radial Conjunction With Ground Location](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.ipynb)).
4. [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/).
These notebooks are also available on
[Binder](https://mybinder.org/v2/gh/berniegsfc/sscws-notebooks/main).
## Motivation
This library hides the HTTP, JSON/XML, and CDF details of the SSC 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/)
2. [numpy](https://pypi.ort/project/numpy/)
3. [matplotlib](https://pypi.org/project/matplotlib/). This is an optional dependency. If it is not installed, the example will simple skip plotting some data.
The critical dependencies above will automatically be installed when this
library is.
## Installation
To install this package
$ pip install -U sscws
or to include plotting
$ pip install -U sscws[plot]
## API Reference
Refer to
[sscws package API reference](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/sscws/index.html)
or use the standard python help mechanism.
from sscws import SscWs
help(SscWs)
## 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://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
Raw data
{
"_id": null,
"home_page": "https://sscweb.gsfc.nasa.gov/WebServices/REST",
"name": "sscws",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "heliophysics, satellites, trajectories, orbits, location, conjunctions, earth magnetic field, ephemeris, space physics, spdf, ssc",
"author": "Bernie Harris",
"author_email": "NASA-SPDF-Support@nasa.onmicrosoft.com",
"download_url": "https://files.pythonhosted.org/packages/96/bc/5c3276a9fc5b2ab605ed91b4f8d766c87098b1637969c0b4e6626e9bfad0/sscws-2.4.tar.gz",
"platform": null,
"description": "\n## Synopsis\n\nThis library provides a simple python interface to \nNASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)\n(SSC). This library implements the client side of the \n[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/).\nFor more general details about the SSC web services, see\nhttps://sscweb.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 sscws\n\n---\n\nThis \n[\"Getting Started\"](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/GetStarted.html) \npage contains information to help someone begin using the sscws library to \naccess information from the \n[Satellite Situation Center](https://sscweb.gsfc.nasa.gov/) in a Python program.\n\n---\n\nAlso, the following [Jupyter notebooks](https://jupyter.org/) demonstrate\ndifferent features of the library:\n1. [Simple Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.ipynb))demonstrating a simple 3D plot of orbit information.\n2. [Complex Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsBTraceExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsBTraceExample.ipynb)) requesting many values including magnetic field line tracing. This example also demonstrates how to diagnose a problem with an invalid request.\n3. [Radial Conjunction With Ground Location](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.ipynb)).\n4. [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/).\n\nThese notebooks are also available on \n[Binder](https://mybinder.org/v2/gh/berniegsfc/sscws-notebooks/main).\n\n## Motivation\n\nThis library hides the HTTP, JSON/XML, and CDF details of the SSC 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/)\n2. [numpy](https://pypi.ort/project/numpy/)\n3. [matplotlib](https://pypi.org/project/matplotlib/). This is an optional dependency. If it is not installed, the example will simple skip plotting some data.\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 sscws\n\nor to include plotting\n\n $ pip install -U sscws[plot]\n\n\n## API Reference\n\nRefer to\n[sscws package API reference](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/sscws/index.html)\n\nor use the standard python help mechanism.\n\n from sscws import SscWs\n help(SscWs)\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://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).\n\n\n",
"bugtrack_url": null,
"license": "NOSA",
"summary": "NASA's Satellite Situation Center Web Service Client Library",
"version": "2.4",
"project_urls": {
"Homepage": "https://sscweb.gsfc.nasa.gov/WebServices/REST"
},
"split_keywords": [
"heliophysics",
" satellites",
" trajectories",
" orbits",
" location",
" conjunctions",
" earth magnetic field",
" ephemeris",
" space physics",
" spdf",
" ssc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33061e028cb17ee80efabae7883c0bb1545dbb018c726339b82eee225223799d",
"md5": "aa6e492e2901bcd415cb1d9d647ceab0",
"sha256": "cecbe346510fa739788ee50dfa7152d7bfd30d6a035aff3ca5cc3c341fb2a060"
},
"downloads": -1,
"filename": "sscws-2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa6e492e2901bcd415cb1d9d647ceab0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 62701,
"upload_time": "2024-04-16T09:38:22",
"upload_time_iso_8601": "2024-04-16T09:38:22.510913Z",
"url": "https://files.pythonhosted.org/packages/33/06/1e028cb17ee80efabae7883c0bb1545dbb018c726339b82eee225223799d/sscws-2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "96bc5c3276a9fc5b2ab605ed91b4f8d766c87098b1637969c0b4e6626e9bfad0",
"md5": "f79d4ffa32244ec3ed13f896b4b73958",
"sha256": "ef8fd69de106fecd2e466e8baf060182a191404e37da0f990661f64de2744b03"
},
"downloads": -1,
"filename": "sscws-2.4.tar.gz",
"has_sig": false,
"md5_digest": "f79d4ffa32244ec3ed13f896b4b73958",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 48057,
"upload_time": "2024-04-16T09:38:27",
"upload_time_iso_8601": "2024-04-16T09:38:27.898566Z",
"url": "https://files.pythonhosted.org/packages/96/bc/5c3276a9fc5b2ab605ed91b4f8d766c87098b1637969c0b4e6626e9bfad0/sscws-2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 09:38:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sscws"
}
JSON