Skip to main content

NASA's Satellite Situation Center Web Service Client Library

Project description

Synopsis

This library provides a simple python interface to NASA's Satellite Situation Center (SSC). This library implements the client side of the SSC RESTful web services. 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" 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

At this time, the only dependency are:

  1. requests
  2. numpy
  3. 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

or use the standard python help mechanism.

from sscws import SscWs
help(SscWs)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sscws-2.3.15.tar.gz (38.5 kB view details)

Uploaded Source

Built Distribution

sscws-2.3.15-py3-none-any.whl (56.5 kB view details)

Uploaded Python 3

File details

Details for the file sscws-2.3.15.tar.gz.

File metadata

  • Download URL: sscws-2.3.15.tar.gz
  • Upload date:
  • Size: 38.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.12

File hashes

Hashes for sscws-2.3.15.tar.gz
Algorithm Hash digest
SHA256 f06f3ba84cfc23bc8e175c1c669ca91b46e81fc7fe5ca53cce6368f2d374c496
MD5 8e141daa804e02a04fd228d70d4daf65
BLAKE2b-256 6aea7d50d8a584a9dc6b46d2a3a66600b86e992b11122f25516c8508c9c0d161

See more details on using hashes here.

File details

Details for the file sscws-2.3.15-py3-none-any.whl.

File metadata

  • Download URL: sscws-2.3.15-py3-none-any.whl
  • Upload date:
  • Size: 56.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.12

File hashes

Hashes for sscws-2.3.15-py3-none-any.whl
Algorithm Hash digest
SHA256 db577eab36d5e58243cb25a4a56635b7464f60a0e70095dfa3f64a1be2496071
MD5 ca2db7717916e730ada3d70a9cbe5244
BLAKE2b-256 4c6bec9527a1a6d850b452e52ba97f01e545c6642b76b177496220cd3c5cadda

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page