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.4.tar.gz (48.1 kB view details)

Uploaded Source

Built Distribution

sscws-2.4-py3-none-any.whl (62.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sscws-2.4.tar.gz
  • Upload date:
  • Size: 48.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.27.1 setuptools/59.6.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.8

File hashes

Hashes for sscws-2.4.tar.gz
Algorithm Hash digest
SHA256 ef8fd69de106fecd2e466e8baf060182a191404e37da0f990661f64de2744b03
MD5 f79d4ffa32244ec3ed13f896b4b73958
BLAKE2b-256 96bc5c3276a9fc5b2ab605ed91b4f8d766c87098b1637969c0b4e6626e9bfad0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sscws-2.4-py3-none-any.whl
  • Upload date:
  • Size: 62.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.27.1 setuptools/59.6.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.8

File hashes

Hashes for sscws-2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cecbe346510fa739788ee50dfa7152d7bfd30d6a035aff3ca5cc3c341fb2a060
MD5 aa6e492e2901bcd415cb1d9d647ceab0
BLAKE2b-256 33061e028cb17ee80efabae7883c0bb1545dbb018c726339b82eee225223799d

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