sscws 2.5.3

Synopsis

NASA's Satellite Situation Center (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.

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" page contains information to help someone begin using the sscws library to access information from the Satellite Situation Center in a Python program.

Also, the following Jupyter notebooks demonstrate different features of the library:

1. Simple Location Example (ipynb file)demonstrating a simple 3D plot of orbit information.
2. Complex Location Example (ipynb file) 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 (ipynb file).
4. Magnetic Field Line Conjunction Example (ipynb file) with related data retrieval/plotting using cdasws.

These notebooks are also available on Binder.

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. httpx2
2. numpy
3. pydantic

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

1. hishel.

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

1. 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

or use the standard python help mechanism.

from sscws import SscWs
help(SscWs)

See also

Tests

The tests directory contains unittest tests.

Contributors

Bernie Harris.
e-mail for support.

License

This code is licensed under the NASA Open Source Agreement (NOSA).