Skip to main content

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.


Badge for the repository entry r3d100010168 in re3data

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

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

  1. requests-cache.

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 description llms.txt

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

Release files for sscws 2.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sscws 2.5.1
File Size Uploaded
sscws-2.5.1.tar.gz 56.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sscws 2.5.1
File Interpreter ABI Platform
sscws-2.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 139.6 kB

Release files / sscws-2.5.1.tar.gz

Download URL sscws-2.5.1.tar.gz
Size 56.3 kB
Tags Source
SHA-256 checksum
How to use checksums
fba2ac4640eb6ec68d1223cf78784ff0bec028d1297179ab76cebb441d58051b
BLAKE2b-256 checksum
How to use checksums
174e856bc2dfbb286b1e9d845f7106827217547ef6397a8b6a27db4038231f67
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / sscws-2.5.1-py3-none-any.whl

Download URL sscws-2.5.1-py3-none-any.whl
Size 83.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c20cdb0b8e32d664510ac8b533839c80dc87ccaf998dd9cf8051d081a96fa111
BLAKE2b-256 checksum
How to use checksums
e4051f1f36b0437ae80df4515a790b1d0f7ad2c9c8c2b93aef429c17fb3dc332
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

This release

2.5.1 This release

2 release files

2.5.0

2 release files

2.4.7

2 release files

2.4.6

2 release files

2.4.5

2 release files

2.4.4

2 release files

2.4.3

2 release files

2.4.2

2 release files

2.4.1

2 release files

2.4

2 release files

2.3.14

2 release files

2.3.13

2 release files

2.3.12

2 release files

2.3.8

2 release files

0.2.4

2 release files

0.2.2

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page