sscws 2.4.2__tar.gz → 2.4.4__tar.gz

{sscws-2.4.2/sscws.egg-info → sscws-2.4.4}/PKG-INFO

@@ -1,13 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sscws
-Version: 2.4.2
+Version: 2.4.4
 Summary: NASA's Satellite Situation Center Web Service Client Library
 Home-page: https://sscweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
 Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
 License: NOSA
 Keywords: heliophysics,satellites,trajectories,orbits,location,conjunctions,earth magnetic field,ephemeris,space physics,spdf,ssc
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
@@ -20,9 +19,28 @@ Classifier: Programming Language :: Python
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: requests>=2.20
+Requires-Dist: numpy>=1.19.4
 Provides-Extra: plot
+Requires-Dist: matplotlib>=3.3.2; extra == "plot"
 Provides-Extra: cdf
-License-File: LICENSE
+Requires-Dist: cdflib>=0.4.9; extra == "cdf"
+Provides-Extra: cache
+Requires-Dist: requests-cache>=1.2.1; extra == "cache"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 
 ## Synopsis
@@ -32,7 +50,9 @@ NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
 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](https://sscweb.gsfc.nasa.gov/WebServices/REST/).
+[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/)
+and can return data for any of 
+[these spacecraft](https://sscweb.gsfc.nasa.gov/scansat.shtml).
 For more general details about the SSC web services, see
 https://sscweb.gsfc.nasa.gov/WebServices/REST/.
 
@@ -71,10 +91,19 @@ methods.
 
 ## Dependencies
 
-At this time, the only dependency are:
+The only required dependencies are the following:
+
 1. [requests](https://pypi.org/project/requests/)
 2. [numpy](https://pypi.ort/project/numpy/)
-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.
+
+If you want to take advantage of HTTP caching, then install the following:
+
+1.  [requests-cache](https://pypi.org/project/requests-cache/).
+
+If you want the example to display a plot of some data, then install the 
+following:
+
+1. [matplotlib](https://pypi.org/project/matplotlib/).
 
 The critical dependencies above will automatically be installed when this 
 library is.
@@ -85,9 +114,9 @@ To install this package
 
     $ pip install -U sscws
 
-or to include plotting
+or to include the optional packages
 
-    $ pip install -U sscws[plot]
+    $ pip install -U sscws[plot,cache]
 
 
 ## API Reference
@@ -115,5 +144,3 @@ Bernie Harris.
 
 This code is licensed under the 
 [NASA Open Source Agreement](https://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
-
-

{sscws-2.4.2 → sscws-2.4.4}/README.md

@@ -6,7 +6,9 @@ NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
 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](https://sscweb.gsfc.nasa.gov/WebServices/REST/).
+[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/)
+and can return data for any of 
+[these spacecraft](https://sscweb.gsfc.nasa.gov/scansat.shtml).
 For more general details about the SSC web services, see
 https://sscweb.gsfc.nasa.gov/WebServices/REST/.
 
@@ -45,10 +47,19 @@ methods.
 
 ## Dependencies
 
-At this time, the only dependency are:
+The only required dependencies are the following:
+
 1. [requests](https://pypi.org/project/requests/)
 2. [numpy](https://pypi.ort/project/numpy/)
-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.
+
+If you want to take advantage of HTTP caching, then install the following:
+
+1.  [requests-cache](https://pypi.org/project/requests-cache/).
+
+If you want the example to display a plot of some data, then install the 
+following:
+
+1. [matplotlib](https://pypi.org/project/matplotlib/).
 
 The critical dependencies above will automatically be installed when this 
 library is.
@@ -59,9 +70,9 @@ To install this package
 
     $ pip install -U sscws
 
-or to include plotting
+or to include the optional packages
 
-    $ pip install -U sscws[plot]
+    $ pip install -U sscws[plot,cache]
 
 
 ## API Reference

{sscws-2.4.2 → sscws-2.4.4}/setup.py

@@ -10,7 +10,7 @@ README = (HERE / "README.md").read_text()
 # This call to setup() does all the work
 setup(
     name="sscws",
-    version="2.4.2",
+    version="2.4.4",
     description="NASA's Satellite Situation Center Web Service Client Library",
     long_description=README,
     long_description_content_type="text/markdown",
@@ -25,7 +25,8 @@ setup(
     install_requires=["python-dateutil>=2.8.0", "requests>=2.20", "numpy>=1.19.4"],
     extras_require={
         'plot': ["matplotlib>=3.3.2"],
-        'cdf': ["cdflib>=0.4.9"]
+        'cdf': ["cdflib>=0.4.9"],
+        'cache': ["requests-cache>=1.2.1"],
     },
     keywords=["heliophysics", "satellites", "trajectories", "orbits", "location", "conjunctions", "earth magnetic field", "ephemeris", "space physics", "spdf", "ssc"],
     classifiers=[

{sscws-2.4.2 → sscws-2.4.4}/sscws/__init__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2020-2024 United States Government as represented by
+# Copyright (c) 2020-2025 United States Government as represented by
 # the National Aeronautics and Space Administration. No copyright is
 # claimed in the United States under Title 17, U.S.Code. All Other
 # Rights Reserved.
@@ -34,7 +34,7 @@
 Package for accessing the NASA's Satellite Situation Center (SSC) web
 services https://sscweb.gsfc.nasa.gov/WebServices/REST/.
 
-Copyright © 2020-2024 United States Government as represented by the
+Copyright © 2020-2025 United States Government as represented by the
 National Aeronautics and Space Administration. No copyright is claimed in
 the United States under Title 17, U.S.Code. All Other Rights Reserved.
 
@@ -55,7 +55,7 @@ Notes
 """
 
 
-__version__ = "2.4.2"
+__version__ = "2.4.4"
 
 
 #

{sscws-2.4.2 → sscws-2.4.4}/sscws/__main__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2013-2023 United States Government as represented by
+# Copyright (c) 2013-2025 United States Government as represented by
 # the National Aeronautics and Space Administration. No copyright is
 # claimed in the United States under Title 17, U.S.Code. All Other
 # Rights Reserved.
@@ -34,7 +34,7 @@
 Example Satellite Situation Center (SSC) web services client.
 https://sscweb.gsfc.nasa.gov/WebServices/REST/.
 
-Copyright © 2013-2023 United States Government as represented by the
+Copyright © 2013-2025 United States Government as represented by the
 National Aeronautics and Space Administration. No copyright is claimed in
 the United States under Title 17, U.S.Code. All Other Rights Reserved.
 """
@@ -123,6 +123,7 @@ def print_usage(
     print(f'USAGE: {name} [-e url][-d][-c cacerts][-h]')
     print('WHERE: url = SSC web service endpoint URL')
     print('       -d disables TLS server certificate validation')
+    print('       -n disables the use of http caching')
     print('       cacerts = CA certificate filename')
 
 
@@ -144,13 +145,14 @@ def example(
             containing the CA certificates to use.<br>
         -d or --disable-cert-check to disable verification of the server's
             certificate
+        -n or --nocache disables the use of http caching
         -h or --help prints help information.
     """
 
     try:
-        opts = getopt.getopt(argv[1:], 'he:c:d',
+        opts = getopt.getopt(argv[1:], 'he:c:dn',
                              ['help', 'endpoint=', 'cacerts=',
-                              'disable-cert-check'])[0]
+                              'disable-cert-check', 'nocache'])[0]
     except getopt.GetoptError:
         print('ERROR: invalid option')
         print_usage(argv[0])
@@ -159,6 +161,7 @@ def example(
     endpoint = ENDPOINT
     ca_certs = None
     disable_ssl_certificate_validation = False
+    disable_cache = False
 
     for opt, arg in opts:
         if opt in ('-e', '--endpoint'):
@@ -168,13 +171,16 @@ def example(
         elif opt in ('-d', '--disable-cert-check'):
             disable_ssl_certificate_validation = True
             urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+        elif opt in ('-n', '--nocache'):
+            disable_cache = True
         elif opt in ('-h', '--help'):
             print_usage(argv[0])
             sys.exit()
 
     ssc = SscWs(endpoint=endpoint, ca_certs=ca_certs,
                 disable_ssl_certificate_validation=
-                disable_ssl_certificate_validation, user_agent='Example')
+                disable_ssl_certificate_validation,
+                disable_cache = disable_cache, user_agent='Example')
 
     result = ssc.get_observatories()
     if result['HttpStatus'] == 200:

{sscws-2.4.2 → sscws-2.4.4}/sscws/cdf.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2023-2024 United States Government as represented by
+# Copyright (c) 2023-2025 United States Government as represented by
 # the National Aeronautics and Space Administration. No copyright is
 # claimed in the United States under Title 17, U.S.Code. All Other
 # Rights Reserved.
@@ -38,7 +38,7 @@ Center (SSC) <https://sscweb.gsfc.nasa.gov>.  This module is specialized
 for SSC CDF files.  It should not be used for more general CDF files.
 <br>
 
-Copyright &copy; 2023-2024 United States Government as represented by the
+Copyright &copy; 2023-2025 United States Government as represented by the
 National Aeronautics and Space Administration. No copyright is claimed in
 the United States under Title 17, U.S.Code. All Other Rights Reserved.
 """
@@ -473,10 +473,13 @@ class Cdf:
             Spacecraft region information.
         """
 
-        region_codes = self.get_value('SPACECRAFT_REGIONS')
-
         regions = []
 
+        try:
+            region_codes = self.get_value('SPACECRAFT_REGIONS')
+        except ValueError:
+            return regions
+
         for region_code in region_codes:
             regions.append(SpaceRegion.from_code(region_code))
 
@@ -496,10 +499,13 @@ class Cdf:
             Trace footpoint region information.
         """
 
-        region_codes = self.get_value(name + 'TRACED_REGIONS')
-
         regions = []
 
+        try:
+            region_codes = self.get_value(name + 'TRACED_REGIONS')
+        except ValueError:
+            return regions
+
         for region_code in region_codes:
             regions.append(FootpointRegion.from_code(region_code))
 
@@ -537,29 +543,47 @@ class Cdf:
         Dict
             The SatelliteData from this CDF.
         """
+        var_names = self.get_variable_names()
         data = {}
         data['Id'] = self.get_satellite_name().lower()
         data['Coordinates'] = self.get_coordinate_data()
         data['Time'] = self.get_time()
-        data['BTraceData'] = self.get_b_trace_data()
-
-        data['RadialLength'] = self.get_value('RADIUS')
-        data['MagneticStrength'] = self.get_value('MAG_STRTH')
-        data['NeutralSheetDistance'] = self.get_value('DNEUTS')
-
-        data['BowShockDistance'] = self.get_value('BOW_SHOCK')
-        data['MagnetoPauseDistance'] = self.get_value('MAG_PAUSE')
-        data['DipoleLValue'] = self.get_value('L_VALUE')
-        data['DipoleInvariantLatitude'] = self.get_value('INVAR_LAT')
-        data['SpacecraftRegion'] = self.get_spacecraft_region()
-        data['RadialTracedFootpointRegions'] = \
-            self.get_footpoint_regions('RADIAL_')
-        data['BGseX'] = self.get_b_gse_component('X')
-        data['BGseY'] = self.get_b_gse_component('Y')
-        data['BGseZ'] = self.get_b_gse_component('Z')
-        data['NorthBTracedFootpointRegions'] = \
-            self.get_footpoint_regions('NORTH_B')
-        data['SouthBTracedFootpointRegions'] = \
-            self.get_footpoint_regions('SOUTH_B')
+        b_trace_data = self.get_b_trace_data()
+        if len(b_trace_data) > 0:
+            data['BTraceData'] = b_trace_data
+
+        if 'RADIUS' in var_names:
+            data['RadialLength'] = self.get_value('RADIUS')
+        if 'MAG_STRTH' in var_names:
+            data['MagneticStrength'] = self.get_value('MAG_STRTH')
+        if 'DNEUTS' in var_names:
+            data['NeutralSheetDistance'] = self.get_value('DNEUTS')
+
+        if 'BOW_SHOCK' in var_names:
+            data['BowShockDistance'] = self.get_value('BOW_SHOCK')
+        if 'MAG_PAUSE' in var_names:
+            data['MagnetoPauseDistance'] = self.get_value('MAG_PAUSE')
+        if 'L_VALUE' in var_names:
+            data['DipoleLValue'] = self.get_value('L_VALUE')
+        if 'INVAR_LAT' in var_names:
+            data['DipoleInvariantLatitude'] = self.get_value('INVAR_LAT')
+        sc_region = self.get_spacecraft_region()
+        if len(sc_region) > 0:
+            data['SpacecraftRegion'] = sc_region
+        if 'RADIAL_TRACED_REGIONS' in var_names:
+            data['RadialTracedFootpointRegions'] = \
+                self.get_footpoint_regions('RADIAL_')
+        if 'MAG_X' in var_names:
+            data['BGseX'] = self.get_b_gse_component('X')
+        if 'MAG_Y' in var_names:
+            data['BGseY'] = self.get_b_gse_component('Y')
+        if 'MAG_Z' in var_names:
+            data['BGseZ'] = self.get_b_gse_component('Z')
+        if 'NORTH_B_TRACED_REGIONS' in var_names:
+            data['NorthBTracedFootpointRegions'] = \
+                self.get_footpoint_regions('NORTH_B')
+        if 'SOUTH_B_TRACED_REGIONS' in var_names:
+            data['SouthBTracedFootpointRegions'] = \
+                self.get_footpoint_regions('SOUTH_B')
 
         return data

{sscws-2.4.2 → sscws-2.4.4}/sscws/sscws.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2013-2024 United States Government as represented by
+# Copyright (c) 2013-2025 United States Government as represented by
 # the National Aeronautics and Space Administration. No copyright is
 # claimed in the United States under Title 17, U.S.Code. All Other
 # Rights Reserved.
@@ -33,6 +33,11 @@
 """
 Module for accessing the Satellite Situation Center (SSC) web services
 https://sscweb.gsfc.nasa.gov/WebServices/REST/.
+<br>
+
+Copyright &copy; 2013-2025 United States Government as represented by the
+National Aeronautics and Space Administration. No copyright is claimed in
+the United States under Title 17, U.S.Code. All Other Rights Reserved.
 """
 
 import sys
@@ -52,6 +57,12 @@ import dateutil.parser
 
 import numpy as np
 
+try:
+    import requests_cache
+    CACHE_AVAILABLE = True
+except ImportError:
+    CACHE_AVAILABLE = False
+
 from sscws import __version__, RETRY_LIMIT, NAMESPACES as NS
 try:
     from sscws.cdf import Cdf
@@ -96,6 +107,8 @@ class SscWs:
         Flag indicating whether to validate the SSL certificate.
     user_agent
         A value that is appended to the HTTP User-Agent values.
+    disable_cache
+        Flag indicating whether to disable HTTP caching.
 
     Notes
     -----
@@ -120,7 +133,8 @@ class SscWs:
             proxy=None,
             ca_certs=None,
             disable_ssl_certificate_validation=False,
-            user_agent=None):
+            user_agent=None,
+            disable_cache=False):
 
         self.logger = logging.getLogger(type(self).__name__)
         self.logger.addHandler(logging.NullHandler())
@@ -131,6 +145,7 @@ class SscWs:
         self.logger.debug('ca_certs = %s', ca_certs)
         self.logger.debug('disable_ssl_certificate_validation = %s',
                           disable_ssl_certificate_validation)
+        self.logger.debug('disable_cache = %s', disable_cache)
 
         if endpoint is None:
             self._endpoint = 'https://sscweb.gsfc.nasa.gov/WS/sscr/2/'
@@ -149,7 +164,12 @@ class SscWs:
             'Accept' : 'application/xml',
             'User-Agent' : self._user_agent
         }
-        self._session = requests.Session()
+        if CACHE_AVAILABLE and disable_cache is not True:
+            self._session = requests_cache.CachedSession('sscws_cache',
+                                                         cache_control=True)
+        else:
+            self._session = requests.Session()
+
         #self._session.max_redirects = 0
         self._session.headers.update(self._request_headers)
 

{sscws-2.4.2 → sscws-2.4.4/sscws.egg-info}/PKG-INFO

@@ -1,13 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sscws
-Version: 2.4.2
+Version: 2.4.4
 Summary: NASA's Satellite Situation Center Web Service Client Library
 Home-page: https://sscweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
 Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
 License: NOSA
 Keywords: heliophysics,satellites,trajectories,orbits,location,conjunctions,earth magnetic field,ephemeris,space physics,spdf,ssc
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
@@ -20,9 +19,28 @@ Classifier: Programming Language :: Python
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: requests>=2.20
+Requires-Dist: numpy>=1.19.4
 Provides-Extra: plot
+Requires-Dist: matplotlib>=3.3.2; extra == "plot"
 Provides-Extra: cdf
-License-File: LICENSE
+Requires-Dist: cdflib>=0.4.9; extra == "cdf"
+Provides-Extra: cache
+Requires-Dist: requests-cache>=1.2.1; extra == "cache"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 
 ## Synopsis
@@ -32,7 +50,9 @@ NASA's [Satellite Situation Center](https://sscweb.gsfc.nasa.gov/)
 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](https://sscweb.gsfc.nasa.gov/WebServices/REST/).
+[SSC RESTful web services](https://sscweb.gsfc.nasa.gov/WebServices/REST/)
+and can return data for any of 
+[these spacecraft](https://sscweb.gsfc.nasa.gov/scansat.shtml).
 For more general details about the SSC web services, see
 https://sscweb.gsfc.nasa.gov/WebServices/REST/.
 
@@ -71,10 +91,19 @@ methods.
 
 ## Dependencies
 
-At this time, the only dependency are:
+The only required dependencies are the following:
+
 1. [requests](https://pypi.org/project/requests/)
 2. [numpy](https://pypi.ort/project/numpy/)
-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.
+
+If you want to take advantage of HTTP caching, then install the following:
+
+1.  [requests-cache](https://pypi.org/project/requests-cache/).
+
+If you want the example to display a plot of some data, then install the 
+following:
+
+1. [matplotlib](https://pypi.org/project/matplotlib/).
 
 The critical dependencies above will automatically be installed when this 
 library is.
@@ -85,9 +114,9 @@ To install this package
 
     $ pip install -U sscws
 
-or to include plotting
+or to include the optional packages
 
-    $ pip install -U sscws[plot]
+    $ pip install -U sscws[plot,cache]
 
 
 ## API Reference
@@ -115,5 +144,3 @@ Bernie Harris.
 
 This code is licensed under the 
 [NASA Open Source Agreement](https://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
-
-

{sscws-2.4.2 → sscws-2.4.4}/sscws.egg-info/SOURCES.txt

@@ -21,4 +21,14 @@ sscws.egg-info/PKG-INFO
 sscws.egg-info/SOURCES.txt
 sscws.egg-info/dependency_links.txt
 sscws.egg-info/requires.txt
-sscws.egg-info/top_level.txt
+sscws.egg-info/top_level.txt
+tests/test_bfieldmodels.py
+tests/test_cdf.py
+tests/test_conjunctions.py
+tests/test_coordinates.py
+tests/test_formatoptions.py
+tests/test_outputoptions.py
+tests/test_regions.py
+tests/test_request.py
+tests/test_sscws.py
+tests/test_timeinterval.py

{sscws-2.4.2 → sscws-2.4.4}/sscws.egg-info/requires.txt

@@ -2,6 +2,9 @@ python-dateutil>=2.8.0
 requests>=2.20
 numpy>=1.19.4
 
+[cache]
+requests-cache>=1.2.1
+
 [cdf]
 cdflib>=0.4.9