Metadata-Version: 2.4
Name: sscws
Version: 2.5.0
Summary: NASA's Satellite Situation Center Web Service Client Library
Author-email: Bernie Harris <NASA-SPDF-Support@nasa.onmicrosoft.com>
License-Expression: NASA-1.3
Project-URL: Homepage, https://berniegsfc.github.io/sscws/REST/
Keywords: heliophysics,satellites,trajectories,orbits,location,conjunctions,earth magnetic field,ephemeris,space physics,NASA,SPDF,SSC
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: python-dateutil>=2.8.0
Requires-Dist: requests>=2.20
Requires-Dist: numpy>=1.19.4
Requires-Dist: pydantic>=2.12.5
Provides-Extra: plot
Requires-Dist: matplotlib>=3.3.2; extra == "plot"
Provides-Extra: cdf
Requires-Dist: cdflib>=0.4.9; extra == "cdf"
Provides-Extra: cache
Requires-Dist: requests-cache>=1.2.1; extra == "cache"
Dynamic: license-file


## Synopsis

NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
(SSC) is a system to cast geocentric spacecraft location information 
into a framework of (empirical) geophysical regions and mappings of 
spacecraft locations along lines of the Earth's magnetic field.  
This library implements the client side of the 
[SSC RESTful web services](https://berniegsfc.github.io/sscws/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://berniegsfc.github.io/sscws/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://berniegsfc.github.io/sscws/REST/jupyter/SscWsExample.html) ([ipynb file](https://berniegsfc.github.io/sscws/REST/jupyter/SscWsExample.ipynb))demonstrating a simple 3D plot of orbit information.
2. [Complex Location Example](https://berniegsfc.github.io/sscws/REST/jupyter/SscWsBTraceExample.html) ([ipynb file](https://berniegsfc.github.io/sscws/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://berniegsfc.github.io/sscws/REST/jupyter/SscWsRadialConjunction.html) ([ipynb file](https://berniegsfc.github.io/sscws/REST/jupyter/SscWsRadialConjunction.ipynb)).
4. [Magnetic Field Line Conjunction Example](https://berniegsfc.github.io/sscws/REST/jupyter/SscWsConjunctionExample.html) ([ipynb file](https://berniegsfc.github.io/sscws/REST/jupyter/SscWsConjunctionExample.ipynb)) with related data retrieval/plotting using [cdasws](https://pypi.org/project/cdasws/).

These notebooks are also available on 
[Binder](https://binder.opensci.2i2c.cloud/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

The only required dependencies are the following:

1. [requests](https://pypi.org/project/requests/)
2. [numpy](https://pypi.org/project/numpy/)
3. [pydantic](https://pypi.org/project/pydantic/)

If you want to take advantage of HTTP caching, then install the following:

1.  [requests-cache](https://pypi.org/project/requests-cache/).

If you want the example to display a plot of some data, then install the 
following:

1. [matplotlib](https://pypi.org/project/matplotlib/).

The critical dependencies above will automatically be installed when this 
library is.

## Installation

To install this package

    $ pip install -U sscws

or to include the optional packages

    $ pip install -U sscws[plot,cache]


## API Reference

Refer to
[sscws package API reference](https://berniegsfc.github.io/sscws/REST/py/api/)

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://berniegsfc.github.io/sscws/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
