sscws 2.4.2__tar.gz → 2.4.3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- sscws-2.4.3/PKG-INFO +118 -0
- {sscws-2.4.2 → sscws-2.4.3}/README.md +3 -1
- {sscws-2.4.2 → sscws-2.4.3}/setup.py +1 -1
- {sscws-2.4.2 → sscws-2.4.3}/sscws/__init__.py +3 -3
- {sscws-2.4.2 → sscws-2.4.3}/sscws/cdf.py +50 -26
- sscws-2.4.3/sscws.egg-info/PKG-INFO +118 -0
- sscws-2.4.2/PKG-INFO +0 -119
- sscws-2.4.2/sscws.egg-info/PKG-INFO +0 -119
- {sscws-2.4.2 → sscws-2.4.3}/LICENSE +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/setup.cfg +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/__main__.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/bfieldmodels.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/conjunctions.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/coordinates.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/filteroptions.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/formatoptions.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/mapping.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/outputoptions.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/regions.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/request.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/result.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/sscws.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/timeinterval.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws/tracing.py +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws.egg-info/SOURCES.txt +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws.egg-info/dependency_links.txt +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws.egg-info/requires.txt +0 -0
- {sscws-2.4.2 → sscws-2.4.3}/sscws.egg-info/top_level.txt +0 -0
sscws-2.4.3/PKG-INFO
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: sscws
|
|
3
|
+
Version: 2.4.3
|
|
4
|
+
Summary: NASA's Satellite Situation Center Web Service Client Library
|
|
5
|
+
Home-page: https://sscweb.gsfc.nasa.gov/WebServices/REST
|
|
6
|
+
Author: Bernie Harris
|
|
7
|
+
Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
|
|
8
|
+
License: NOSA
|
|
9
|
+
Description:
|
|
10
|
+
## Synopsis
|
|
11
|
+
|
|
12
|
+
NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
|
|
13
|
+
(SSC) is a system to cast geocentric spacecraft location information
|
|
14
|
+
into a framework of (empirical) geophysical regions and mappings of
|
|
15
|
+
spacecraft locations along lines of the Earth's magnetic field.
|
|
16
|
+
This library implements the client side of the
|
|
17
|
+
[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/)
|
|
18
|
+
and can return data for any of
|
|
19
|
+
[these spacecraft](https://sscweb.gsfc.nasa.gov/scansat.shtml).
|
|
20
|
+
For more general details about the SSC web services, see
|
|
21
|
+
https://sscweb.gsfc.nasa.gov/WebServices/REST/.
|
|
22
|
+
|
|
23
|
+
## Code Example
|
|
24
|
+
|
|
25
|
+
This package contains example code calling most of the available web services.
|
|
26
|
+
To run the included example, do the following
|
|
27
|
+
|
|
28
|
+
python -m sscws
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
This
|
|
33
|
+
["Getting Started"](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/GetStarted.html)
|
|
34
|
+
page contains information to help someone begin using the sscws library to
|
|
35
|
+
access information from the
|
|
36
|
+
[Satellite Situation Center](https://sscweb.gsfc.nasa.gov/) in a Python program.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
|
|
41
|
+
different features of the library:
|
|
42
|
+
1. [Simple Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.ipynb))demonstrating a simple 3D plot of orbit information.
|
|
43
|
+
2. [Complex Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsBTraceExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/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.
|
|
44
|
+
3. [Radial Conjunction With Ground Location](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.ipynb)).
|
|
45
|
+
4. [Magnetic Field Line Conjunction Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.ipynb)) with related data retrieval/plotting using [cdasws](https://pypi.org/project/cdasws/).
|
|
46
|
+
|
|
47
|
+
These notebooks are also available on
|
|
48
|
+
[Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/sscws-notebooks/main).
|
|
49
|
+
|
|
50
|
+
## Motivation
|
|
51
|
+
|
|
52
|
+
This library hides the HTTP, JSON/XML, and CDF details of the SSC web
|
|
53
|
+
services. A python developer only has to deal with python objects and
|
|
54
|
+
methods.
|
|
55
|
+
|
|
56
|
+
## Dependencies
|
|
57
|
+
|
|
58
|
+
At this time, the only dependency are:
|
|
59
|
+
1. [requests](https://pypi.org/project/requests/)
|
|
60
|
+
2. [numpy](https://pypi.ort/project/numpy/)
|
|
61
|
+
3. [matplotlib](https://pypi.org/project/matplotlib/). This is an optional dependency. If it is not installed, the example will simple skip plotting some data.
|
|
62
|
+
|
|
63
|
+
The critical dependencies above will automatically be installed when this
|
|
64
|
+
library is.
|
|
65
|
+
|
|
66
|
+
## Installation
|
|
67
|
+
|
|
68
|
+
To install this package
|
|
69
|
+
|
|
70
|
+
$ pip install -U sscws
|
|
71
|
+
|
|
72
|
+
or to include plotting
|
|
73
|
+
|
|
74
|
+
$ pip install -U sscws[plot]
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
## API Reference
|
|
78
|
+
|
|
79
|
+
Refer to
|
|
80
|
+
[sscws package API reference](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/sscws/index.html)
|
|
81
|
+
|
|
82
|
+
or use the standard python help mechanism.
|
|
83
|
+
|
|
84
|
+
from sscws import SscWs
|
|
85
|
+
help(SscWs)
|
|
86
|
+
|
|
87
|
+
## Tests
|
|
88
|
+
|
|
89
|
+
The tests directory contains
|
|
90
|
+
[unittest](https://docs.python.org/3/library/unittest.html)
|
|
91
|
+
tests.
|
|
92
|
+
|
|
93
|
+
## Contributors
|
|
94
|
+
|
|
95
|
+
Bernie Harris.
|
|
96
|
+
[e-mail](mailto:NASA-SPDF-Support@nasa.onmicrosoft.com) for support.
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
This code is licensed under the
|
|
101
|
+
[NASA Open Source Agreement](https://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
|
|
102
|
+
|
|
103
|
+
Keywords: heliophysics,satellites,trajectories,orbits,location,conjunctions,earth magnetic field,ephemeris,space physics,spdf,ssc
|
|
104
|
+
Platform: UNKNOWN
|
|
105
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
106
|
+
Classifier: Environment :: Console
|
|
107
|
+
Classifier: Environment :: Web Environment
|
|
108
|
+
Classifier: Intended Audience :: End Users/Desktop
|
|
109
|
+
Classifier: Intended Audience :: Developers
|
|
110
|
+
Classifier: Intended Audience :: System Administrators
|
|
111
|
+
Classifier: License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)
|
|
112
|
+
Classifier: Operating System :: OS Independent
|
|
113
|
+
Classifier: Programming Language :: Python
|
|
114
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
115
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
116
|
+
Description-Content-Type: text/markdown
|
|
117
|
+
Provides-Extra: plot
|
|
118
|
+
Provides-Extra: cdf
|
|
@@ -6,7 +6,9 @@ NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
|
|
|
6
6
|
into a framework of (empirical) geophysical regions and mappings of
|
|
7
7
|
spacecraft locations along lines of the Earth's magnetic field.
|
|
8
8
|
This library implements the client side of the
|
|
9
|
-
[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/)
|
|
9
|
+
[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/)
|
|
10
|
+
and can return data for any of
|
|
11
|
+
[these spacecraft](https://sscweb.gsfc.nasa.gov/scansat.shtml).
|
|
10
12
|
For more general details about the SSC web services, see
|
|
11
13
|
https://sscweb.gsfc.nasa.gov/WebServices/REST/.
|
|
12
14
|
|
|
@@ -10,7 +10,7 @@ README = (HERE / "README.md").read_text()
|
|
|
10
10
|
# This call to setup() does all the work
|
|
11
11
|
setup(
|
|
12
12
|
name="sscws",
|
|
13
|
-
version="2.4.
|
|
13
|
+
version="2.4.3",
|
|
14
14
|
description="NASA's Satellite Situation Center Web Service Client Library",
|
|
15
15
|
long_description=README,
|
|
16
16
|
long_description_content_type="text/markdown",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
#
|
|
25
25
|
# NOSA HEADER END
|
|
26
26
|
#
|
|
27
|
-
# Copyright (c) 2020-
|
|
27
|
+
# Copyright (c) 2020-2025 United States Government as represented by
|
|
28
28
|
# the National Aeronautics and Space Administration. No copyright is
|
|
29
29
|
# claimed in the United States under Title 17, U.S.Code. All Other
|
|
30
30
|
# Rights Reserved.
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
Package for accessing the NASA's Satellite Situation Center (SSC) web
|
|
35
35
|
services https://sscweb.gsfc.nasa.gov/WebServices/REST/.
|
|
36
36
|
|
|
37
|
-
Copyright © 2020-
|
|
37
|
+
Copyright © 2020-2025 United States Government as represented by the
|
|
38
38
|
National Aeronautics and Space Administration. No copyright is claimed in
|
|
39
39
|
the United States under Title 17, U.S.Code. All Other Rights Reserved.
|
|
40
40
|
|
|
@@ -55,7 +55,7 @@ Notes
|
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
|
|
58
|
-
__version__ = "2.4.
|
|
58
|
+
__version__ = "2.4.3"
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
#
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
#
|
|
25
25
|
# NOSA HEADER END
|
|
26
26
|
#
|
|
27
|
-
# Copyright (c) 2023-
|
|
27
|
+
# Copyright (c) 2023-2025 United States Government as represented by
|
|
28
28
|
# the National Aeronautics and Space Administration. No copyright is
|
|
29
29
|
# claimed in the United States under Title 17, U.S.Code. All Other
|
|
30
30
|
# Rights Reserved.
|
|
@@ -38,7 +38,7 @@ Center (SSC) <https://sscweb.gsfc.nasa.gov>. This module is specialized
|
|
|
38
38
|
for SSC CDF files. It should not be used for more general CDF files.
|
|
39
39
|
<br>
|
|
40
40
|
|
|
41
|
-
Copyright © 2023-
|
|
41
|
+
Copyright © 2023-2025 United States Government as represented by the
|
|
42
42
|
National Aeronautics and Space Administration. No copyright is claimed in
|
|
43
43
|
the United States under Title 17, U.S.Code. All Other Rights Reserved.
|
|
44
44
|
"""
|
|
@@ -473,10 +473,13 @@ class Cdf:
|
|
|
473
473
|
Spacecraft region information.
|
|
474
474
|
"""
|
|
475
475
|
|
|
476
|
-
region_codes = self.get_value('SPACECRAFT_REGIONS')
|
|
477
|
-
|
|
478
476
|
regions = []
|
|
479
477
|
|
|
478
|
+
try:
|
|
479
|
+
region_codes = self.get_value('SPACECRAFT_REGIONS')
|
|
480
|
+
except ValueError:
|
|
481
|
+
return regions
|
|
482
|
+
|
|
480
483
|
for region_code in region_codes:
|
|
481
484
|
regions.append(SpaceRegion.from_code(region_code))
|
|
482
485
|
|
|
@@ -496,10 +499,13 @@ class Cdf:
|
|
|
496
499
|
Trace footpoint region information.
|
|
497
500
|
"""
|
|
498
501
|
|
|
499
|
-
region_codes = self.get_value(name + 'TRACED_REGIONS')
|
|
500
|
-
|
|
501
502
|
regions = []
|
|
502
503
|
|
|
504
|
+
try:
|
|
505
|
+
region_codes = self.get_value(name + 'TRACED_REGIONS')
|
|
506
|
+
except ValueError:
|
|
507
|
+
return regions
|
|
508
|
+
|
|
503
509
|
for region_code in region_codes:
|
|
504
510
|
regions.append(FootpointRegion.from_code(region_code))
|
|
505
511
|
|
|
@@ -537,29 +543,47 @@ class Cdf:
|
|
|
537
543
|
Dict
|
|
538
544
|
The SatelliteData from this CDF.
|
|
539
545
|
"""
|
|
546
|
+
var_names = self.get_variable_names()
|
|
540
547
|
data = {}
|
|
541
548
|
data['Id'] = self.get_satellite_name().lower()
|
|
542
549
|
data['Coordinates'] = self.get_coordinate_data()
|
|
543
550
|
data['Time'] = self.get_time()
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
self.
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
551
|
+
b_trace_data = self.get_b_trace_data()
|
|
552
|
+
if len(b_trace_data) > 0:
|
|
553
|
+
data['BTraceData'] = b_trace_data
|
|
554
|
+
|
|
555
|
+
if 'RADIUS' in var_names:
|
|
556
|
+
data['RadialLength'] = self.get_value('RADIUS')
|
|
557
|
+
if 'MAG_STRTH' in var_names:
|
|
558
|
+
data['MagneticStrength'] = self.get_value('MAG_STRTH')
|
|
559
|
+
if 'DNEUTS' in var_names:
|
|
560
|
+
data['NeutralSheetDistance'] = self.get_value('DNEUTS')
|
|
561
|
+
|
|
562
|
+
if 'BOW_SHOCK' in var_names:
|
|
563
|
+
data['BowShockDistance'] = self.get_value('BOW_SHOCK')
|
|
564
|
+
if 'MAG_PAUSE' in var_names:
|
|
565
|
+
data['MagnetoPauseDistance'] = self.get_value('MAG_PAUSE')
|
|
566
|
+
if 'L_VALUE' in var_names:
|
|
567
|
+
data['DipoleLValue'] = self.get_value('L_VALUE')
|
|
568
|
+
if 'INVAR_LAT' in var_names:
|
|
569
|
+
data['DipoleInvariantLatitude'] = self.get_value('INVAR_LAT')
|
|
570
|
+
sc_region = self.get_spacecraft_region()
|
|
571
|
+
if len(sc_region) > 0:
|
|
572
|
+
data['SpacecraftRegion'] = sc_region
|
|
573
|
+
if 'RADIAL_TRACED_REGIONS' in var_names:
|
|
574
|
+
data['RadialTracedFootpointRegions'] = \
|
|
575
|
+
self.get_footpoint_regions('RADIAL_')
|
|
576
|
+
if 'MAG_X' in var_names:
|
|
577
|
+
data['BGseX'] = self.get_b_gse_component('X')
|
|
578
|
+
if 'MAG_Y' in var_names:
|
|
579
|
+
data['BGseY'] = self.get_b_gse_component('Y')
|
|
580
|
+
if 'MAG_Z' in var_names:
|
|
581
|
+
data['BGseZ'] = self.get_b_gse_component('Z')
|
|
582
|
+
if 'NORTH_B_TRACED_REGIONS' in var_names:
|
|
583
|
+
data['NorthBTracedFootpointRegions'] = \
|
|
584
|
+
self.get_footpoint_regions('NORTH_B')
|
|
585
|
+
if 'SOUTH_B_TRACED_REGIONS' in var_names:
|
|
586
|
+
data['SouthBTracedFootpointRegions'] = \
|
|
587
|
+
self.get_footpoint_regions('SOUTH_B')
|
|
564
588
|
|
|
565
589
|
return data
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: sscws
|
|
3
|
+
Version: 2.4.3
|
|
4
|
+
Summary: NASA's Satellite Situation Center Web Service Client Library
|
|
5
|
+
Home-page: https://sscweb.gsfc.nasa.gov/WebServices/REST
|
|
6
|
+
Author: Bernie Harris
|
|
7
|
+
Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
|
|
8
|
+
License: NOSA
|
|
9
|
+
Description:
|
|
10
|
+
## Synopsis
|
|
11
|
+
|
|
12
|
+
NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
|
|
13
|
+
(SSC) is a system to cast geocentric spacecraft location information
|
|
14
|
+
into a framework of (empirical) geophysical regions and mappings of
|
|
15
|
+
spacecraft locations along lines of the Earth's magnetic field.
|
|
16
|
+
This library implements the client side of the
|
|
17
|
+
[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/)
|
|
18
|
+
and can return data for any of
|
|
19
|
+
[these spacecraft](https://sscweb.gsfc.nasa.gov/scansat.shtml).
|
|
20
|
+
For more general details about the SSC web services, see
|
|
21
|
+
https://sscweb.gsfc.nasa.gov/WebServices/REST/.
|
|
22
|
+
|
|
23
|
+
## Code Example
|
|
24
|
+
|
|
25
|
+
This package contains example code calling most of the available web services.
|
|
26
|
+
To run the included example, do the following
|
|
27
|
+
|
|
28
|
+
python -m sscws
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
This
|
|
33
|
+
["Getting Started"](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/GetStarted.html)
|
|
34
|
+
page contains information to help someone begin using the sscws library to
|
|
35
|
+
access information from the
|
|
36
|
+
[Satellite Situation Center](https://sscweb.gsfc.nasa.gov/) in a Python program.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
|
|
41
|
+
different features of the library:
|
|
42
|
+
1. [Simple Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.ipynb))demonstrating a simple 3D plot of orbit information.
|
|
43
|
+
2. [Complex Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsBTraceExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/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.
|
|
44
|
+
3. [Radial Conjunction With Ground Location](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.ipynb)).
|
|
45
|
+
4. [Magnetic Field Line Conjunction Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.ipynb)) with related data retrieval/plotting using [cdasws](https://pypi.org/project/cdasws/).
|
|
46
|
+
|
|
47
|
+
These notebooks are also available on
|
|
48
|
+
[Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/sscws-notebooks/main).
|
|
49
|
+
|
|
50
|
+
## Motivation
|
|
51
|
+
|
|
52
|
+
This library hides the HTTP, JSON/XML, and CDF details of the SSC web
|
|
53
|
+
services. A python developer only has to deal with python objects and
|
|
54
|
+
methods.
|
|
55
|
+
|
|
56
|
+
## Dependencies
|
|
57
|
+
|
|
58
|
+
At this time, the only dependency are:
|
|
59
|
+
1. [requests](https://pypi.org/project/requests/)
|
|
60
|
+
2. [numpy](https://pypi.ort/project/numpy/)
|
|
61
|
+
3. [matplotlib](https://pypi.org/project/matplotlib/). This is an optional dependency. If it is not installed, the example will simple skip plotting some data.
|
|
62
|
+
|
|
63
|
+
The critical dependencies above will automatically be installed when this
|
|
64
|
+
library is.
|
|
65
|
+
|
|
66
|
+
## Installation
|
|
67
|
+
|
|
68
|
+
To install this package
|
|
69
|
+
|
|
70
|
+
$ pip install -U sscws
|
|
71
|
+
|
|
72
|
+
or to include plotting
|
|
73
|
+
|
|
74
|
+
$ pip install -U sscws[plot]
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
## API Reference
|
|
78
|
+
|
|
79
|
+
Refer to
|
|
80
|
+
[sscws package API reference](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/sscws/index.html)
|
|
81
|
+
|
|
82
|
+
or use the standard python help mechanism.
|
|
83
|
+
|
|
84
|
+
from sscws import SscWs
|
|
85
|
+
help(SscWs)
|
|
86
|
+
|
|
87
|
+
## Tests
|
|
88
|
+
|
|
89
|
+
The tests directory contains
|
|
90
|
+
[unittest](https://docs.python.org/3/library/unittest.html)
|
|
91
|
+
tests.
|
|
92
|
+
|
|
93
|
+
## Contributors
|
|
94
|
+
|
|
95
|
+
Bernie Harris.
|
|
96
|
+
[e-mail](mailto:NASA-SPDF-Support@nasa.onmicrosoft.com) for support.
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
This code is licensed under the
|
|
101
|
+
[NASA Open Source Agreement](https://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
|
|
102
|
+
|
|
103
|
+
Keywords: heliophysics,satellites,trajectories,orbits,location,conjunctions,earth magnetic field,ephemeris,space physics,spdf,ssc
|
|
104
|
+
Platform: UNKNOWN
|
|
105
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
106
|
+
Classifier: Environment :: Console
|
|
107
|
+
Classifier: Environment :: Web Environment
|
|
108
|
+
Classifier: Intended Audience :: End Users/Desktop
|
|
109
|
+
Classifier: Intended Audience :: Developers
|
|
110
|
+
Classifier: Intended Audience :: System Administrators
|
|
111
|
+
Classifier: License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)
|
|
112
|
+
Classifier: Operating System :: OS Independent
|
|
113
|
+
Classifier: Programming Language :: Python
|
|
114
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
115
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
116
|
+
Description-Content-Type: text/markdown
|
|
117
|
+
Provides-Extra: plot
|
|
118
|
+
Provides-Extra: cdf
|
sscws-2.4.2/PKG-INFO
DELETED
|
@@ -1,119 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: sscws
|
|
3
|
-
Version: 2.4.2
|
|
4
|
-
Summary: NASA's Satellite Situation Center Web Service Client Library
|
|
5
|
-
Home-page: https://sscweb.gsfc.nasa.gov/WebServices/REST
|
|
6
|
-
Author: Bernie Harris
|
|
7
|
-
Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
|
|
8
|
-
License: NOSA
|
|
9
|
-
Keywords: heliophysics,satellites,trajectories,orbits,location,conjunctions,earth magnetic field,ephemeris,space physics,spdf,ssc
|
|
10
|
-
Platform: UNKNOWN
|
|
11
|
-
Classifier: Development Status :: 5 - Production/Stable
|
|
12
|
-
Classifier: Environment :: Console
|
|
13
|
-
Classifier: Environment :: Web Environment
|
|
14
|
-
Classifier: Intended Audience :: End Users/Desktop
|
|
15
|
-
Classifier: Intended Audience :: Developers
|
|
16
|
-
Classifier: Intended Audience :: System Administrators
|
|
17
|
-
Classifier: License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)
|
|
18
|
-
Classifier: Operating System :: OS Independent
|
|
19
|
-
Classifier: Programming Language :: Python
|
|
20
|
-
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
21
|
-
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
22
|
-
Description-Content-Type: text/markdown
|
|
23
|
-
Provides-Extra: plot
|
|
24
|
-
Provides-Extra: cdf
|
|
25
|
-
License-File: LICENSE
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
## Synopsis
|
|
29
|
-
|
|
30
|
-
NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
|
|
31
|
-
(SSC) is a system to cast geocentric spacecraft location information
|
|
32
|
-
into a framework of (empirical) geophysical regions and mappings of
|
|
33
|
-
spacecraft locations along lines of the Earth's magnetic field.
|
|
34
|
-
This library implements the client side of the
|
|
35
|
-
[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/).
|
|
36
|
-
For more general details about the SSC web services, see
|
|
37
|
-
https://sscweb.gsfc.nasa.gov/WebServices/REST/.
|
|
38
|
-
|
|
39
|
-
## Code Example
|
|
40
|
-
|
|
41
|
-
This package contains example code calling most of the available web services.
|
|
42
|
-
To run the included example, do the following
|
|
43
|
-
|
|
44
|
-
python -m sscws
|
|
45
|
-
|
|
46
|
-
---
|
|
47
|
-
|
|
48
|
-
This
|
|
49
|
-
["Getting Started"](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/GetStarted.html)
|
|
50
|
-
page contains information to help someone begin using the sscws library to
|
|
51
|
-
access information from the
|
|
52
|
-
[Satellite Situation Center](https://sscweb.gsfc.nasa.gov/) in a Python program.
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
|
|
57
|
-
different features of the library:
|
|
58
|
-
1. [Simple Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.ipynb))demonstrating a simple 3D plot of orbit information.
|
|
59
|
-
2. [Complex Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsBTraceExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/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.
|
|
60
|
-
3. [Radial Conjunction With Ground Location](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.ipynb)).
|
|
61
|
-
4. [Magnetic Field Line Conjunction Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.ipynb)) with related data retrieval/plotting using [cdasws](https://pypi.org/project/cdasws/).
|
|
62
|
-
|
|
63
|
-
These notebooks are also available on
|
|
64
|
-
[Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/sscws-notebooks/main).
|
|
65
|
-
|
|
66
|
-
## Motivation
|
|
67
|
-
|
|
68
|
-
This library hides the HTTP, JSON/XML, and CDF details of the SSC web
|
|
69
|
-
services. A python developer only has to deal with python objects and
|
|
70
|
-
methods.
|
|
71
|
-
|
|
72
|
-
## Dependencies
|
|
73
|
-
|
|
74
|
-
At this time, the only dependency are:
|
|
75
|
-
1. [requests](https://pypi.org/project/requests/)
|
|
76
|
-
2. [numpy](https://pypi.ort/project/numpy/)
|
|
77
|
-
3. [matplotlib](https://pypi.org/project/matplotlib/). This is an optional dependency. If it is not installed, the example will simple skip plotting some data.
|
|
78
|
-
|
|
79
|
-
The critical dependencies above will automatically be installed when this
|
|
80
|
-
library is.
|
|
81
|
-
|
|
82
|
-
## Installation
|
|
83
|
-
|
|
84
|
-
To install this package
|
|
85
|
-
|
|
86
|
-
$ pip install -U sscws
|
|
87
|
-
|
|
88
|
-
or to include plotting
|
|
89
|
-
|
|
90
|
-
$ pip install -U sscws[plot]
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
## API Reference
|
|
94
|
-
|
|
95
|
-
Refer to
|
|
96
|
-
[sscws package API reference](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/sscws/index.html)
|
|
97
|
-
|
|
98
|
-
or use the standard python help mechanism.
|
|
99
|
-
|
|
100
|
-
from sscws import SscWs
|
|
101
|
-
help(SscWs)
|
|
102
|
-
|
|
103
|
-
## Tests
|
|
104
|
-
|
|
105
|
-
The tests directory contains
|
|
106
|
-
[unittest](https://docs.python.org/3/library/unittest.html)
|
|
107
|
-
tests.
|
|
108
|
-
|
|
109
|
-
## Contributors
|
|
110
|
-
|
|
111
|
-
Bernie Harris.
|
|
112
|
-
[e-mail](mailto:NASA-SPDF-Support@nasa.onmicrosoft.com) for support.
|
|
113
|
-
|
|
114
|
-
## License
|
|
115
|
-
|
|
116
|
-
This code is licensed under the
|
|
117
|
-
[NASA Open Source Agreement](https://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
|
|
118
|
-
|
|
119
|
-
|
|
@@ -1,119 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: sscws
|
|
3
|
-
Version: 2.4.2
|
|
4
|
-
Summary: NASA's Satellite Situation Center Web Service Client Library
|
|
5
|
-
Home-page: https://sscweb.gsfc.nasa.gov/WebServices/REST
|
|
6
|
-
Author: Bernie Harris
|
|
7
|
-
Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
|
|
8
|
-
License: NOSA
|
|
9
|
-
Keywords: heliophysics,satellites,trajectories,orbits,location,conjunctions,earth magnetic field,ephemeris,space physics,spdf,ssc
|
|
10
|
-
Platform: UNKNOWN
|
|
11
|
-
Classifier: Development Status :: 5 - Production/Stable
|
|
12
|
-
Classifier: Environment :: Console
|
|
13
|
-
Classifier: Environment :: Web Environment
|
|
14
|
-
Classifier: Intended Audience :: End Users/Desktop
|
|
15
|
-
Classifier: Intended Audience :: Developers
|
|
16
|
-
Classifier: Intended Audience :: System Administrators
|
|
17
|
-
Classifier: License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)
|
|
18
|
-
Classifier: Operating System :: OS Independent
|
|
19
|
-
Classifier: Programming Language :: Python
|
|
20
|
-
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
21
|
-
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
22
|
-
Description-Content-Type: text/markdown
|
|
23
|
-
Provides-Extra: plot
|
|
24
|
-
Provides-Extra: cdf
|
|
25
|
-
License-File: LICENSE
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
## Synopsis
|
|
29
|
-
|
|
30
|
-
NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
|
|
31
|
-
(SSC) is a system to cast geocentric spacecraft location information
|
|
32
|
-
into a framework of (empirical) geophysical regions and mappings of
|
|
33
|
-
spacecraft locations along lines of the Earth's magnetic field.
|
|
34
|
-
This library implements the client side of the
|
|
35
|
-
[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/).
|
|
36
|
-
For more general details about the SSC web services, see
|
|
37
|
-
https://sscweb.gsfc.nasa.gov/WebServices/REST/.
|
|
38
|
-
|
|
39
|
-
## Code Example
|
|
40
|
-
|
|
41
|
-
This package contains example code calling most of the available web services.
|
|
42
|
-
To run the included example, do the following
|
|
43
|
-
|
|
44
|
-
python -m sscws
|
|
45
|
-
|
|
46
|
-
---
|
|
47
|
-
|
|
48
|
-
This
|
|
49
|
-
["Getting Started"](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/GetStarted.html)
|
|
50
|
-
page contains information to help someone begin using the sscws library to
|
|
51
|
-
access information from the
|
|
52
|
-
[Satellite Situation Center](https://sscweb.gsfc.nasa.gov/) in a Python program.
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
|
|
57
|
-
different features of the library:
|
|
58
|
-
1. [Simple Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsExample.ipynb))demonstrating a simple 3D plot of orbit information.
|
|
59
|
-
2. [Complex Location Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsBTraceExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/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.
|
|
60
|
-
3. [Radial Conjunction With Ground Location](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsRadialConjunction.ipynb)).
|
|
61
|
-
4. [Magnetic Field Line Conjunction Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.ipynb)) with related data retrieval/plotting using [cdasws](https://pypi.org/project/cdasws/).
|
|
62
|
-
|
|
63
|
-
These notebooks are also available on
|
|
64
|
-
[Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/sscws-notebooks/main).
|
|
65
|
-
|
|
66
|
-
## Motivation
|
|
67
|
-
|
|
68
|
-
This library hides the HTTP, JSON/XML, and CDF details of the SSC web
|
|
69
|
-
services. A python developer only has to deal with python objects and
|
|
70
|
-
methods.
|
|
71
|
-
|
|
72
|
-
## Dependencies
|
|
73
|
-
|
|
74
|
-
At this time, the only dependency are:
|
|
75
|
-
1. [requests](https://pypi.org/project/requests/)
|
|
76
|
-
2. [numpy](https://pypi.ort/project/numpy/)
|
|
77
|
-
3. [matplotlib](https://pypi.org/project/matplotlib/). This is an optional dependency. If it is not installed, the example will simple skip plotting some data.
|
|
78
|
-
|
|
79
|
-
The critical dependencies above will automatically be installed when this
|
|
80
|
-
library is.
|
|
81
|
-
|
|
82
|
-
## Installation
|
|
83
|
-
|
|
84
|
-
To install this package
|
|
85
|
-
|
|
86
|
-
$ pip install -U sscws
|
|
87
|
-
|
|
88
|
-
or to include plotting
|
|
89
|
-
|
|
90
|
-
$ pip install -U sscws[plot]
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
## API Reference
|
|
94
|
-
|
|
95
|
-
Refer to
|
|
96
|
-
[sscws package API reference](https://sscweb.gsfc.nasa.gov/WebServices/REST/py/sscws/index.html)
|
|
97
|
-
|
|
98
|
-
or use the standard python help mechanism.
|
|
99
|
-
|
|
100
|
-
from sscws import SscWs
|
|
101
|
-
help(SscWs)
|
|
102
|
-
|
|
103
|
-
## Tests
|
|
104
|
-
|
|
105
|
-
The tests directory contains
|
|
106
|
-
[unittest](https://docs.python.org/3/library/unittest.html)
|
|
107
|
-
tests.
|
|
108
|
-
|
|
109
|
-
## Contributors
|
|
110
|
-
|
|
111
|
-
Bernie Harris.
|
|
112
|
-
[e-mail](mailto:NASA-SPDF-Support@nasa.onmicrosoft.com) for support.
|
|
113
|
-
|
|
114
|
-
## License
|
|
115
|
-
|
|
116
|
-
This code is licensed under the
|
|
117
|
-
[NASA Open Source Agreement](https://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
|
|
118
|
-
|
|
119
|
-
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|