cdasws 1.8.11__tar.gz → 1.8.12__tar.gz

{cdasws-1.8.11 → cdasws-1.8.12}/LICENSE

@@ -17,7 +17,7 @@ Government Agency Original Software Designation: GSC-14730-1
 Government Agency Original Software Title: "Space Physics Data Facility Web Services"
 User Registration Requested.  Please Visit http://spdf.gsfc.nasa.gov/
 Government Agency Point of Contact for Original Software: 
-    gsfc-spdf-support@lists.nasa.gov
+    NASA-SPDF-Support@nasa.onmicrosoft.com
 
 
 1. DEFINITIONS

{cdasws-1.8.11 → cdasws-1.8.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cdasws
-Version: 1.8.11
+Version: 1.8.12
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
@@ -57,6 +57,8 @@ and can return data from any of
 [pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html)
 with all source and 
 [ISTP/SPDF](https://spdf.gsfc.nasa.gov/sp_use_of_cdf.html) metadata.
+Note that this package is included in the [HelioCloud](https://heliocloud.org/)
+base image, so there is no need to install it there.
 Frequently asked questions concerning this library are at 
 [FAQ](https://cdaweb.gsfc.nasa.gov/WebServices/REST/py/FAQ.html).
 For more general details about the CDAS web services, see

{cdasws-1.8.11 → cdasws-1.8.12}/README.md

@@ -13,6 +13,8 @@ and can return data from any of
 [pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html)
 with all source and 
 [ISTP/SPDF](https://spdf.gsfc.nasa.gov/sp_use_of_cdf.html) metadata.
+Note that this package is included in the [HelioCloud](https://heliocloud.org/)
+base image, so there is no need to install it there.
 Frequently asked questions concerning this library are at 
 [FAQ](https://cdaweb.gsfc.nasa.gov/WebServices/REST/py/FAQ.html).
 For more general details about the CDAS web services, see

cdasws-1.8.12/cdasws/__init__.py

@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+
+#
+# NOSA HEADER START
+#
+# The contents of this file are subject to the terms of the NASA Open
+# Source Agreement (NOSA), Version 1.3 only (the "Agreement").  You may
+# not use this file except in compliance with the Agreement.
+#
+# You can obtain a copy of the agreement at
+#   docs/NASA_Open_Source_Agreement_1.3.txt
+# or
+#   https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.
+#
+# See the Agreement for the specific language governing permissions
+# and limitations under the Agreement.
+#
+# When distributing Covered Code, include this NOSA HEADER in each
+# file and include the Agreement file at
+# docs/NASA_Open_Source_Agreement_1.3.txt.  If applicable, add the
+# following below this NOSA HEADER, with the fields enclosed by
+# brackets "[]" replaced with your own identifying information:
+# Portions Copyright [yyyy] [name of copyright owner]
+#
+# NOSA HEADER END
+#
+# Copyright (c) 2018-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.
+#
+
+
+"""
+Package for accessing the Coordinate Data Analysis System (CDAS)
+web services <https://cdaweb.gsfc.nasa.gov/WebServices/REST/>.<br>
+
+Copyright &copy; 2018-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.
+
+Notes
+-----
+<ul>
+  <li>Due to rate limiting implemented by the CDAS web services, an
+      attempt to make simultaneous requests from many threads is likely
+      to actually reduce performance.  At this time, it is best to make
+      calls from five or fewer threads.</li>
+  <li>Since CDAS data has datetime values with a UTC timezone, all
+      client provided datetime values should have a timezone of UTC.
+      If a given value's timezone is not UTC, the value is adjusted to
+      UTC.  If a given value has no timezone (is naive), a UTC timezone
+      is set.</li>
+</ul>
+"""
+
+
+__version__ = "1.8.12"
+
+
+#
+# Limit on the number of times an HTTP request which returns a
+# 429 or 503 status with a Retry-After header will be retried.
+#
+RETRY_LIMIT = 100
+
+#
+# XML schema namespace
+#
+NS = 'http://cdaweb.gsfc.nasa.gov/schema'
+#
+# XHTML schema namespace
+#
+XHTML_NS = 'http://www.w3.org/1999/xhtml'
+#
+# All namespaces found in responses.
+#
+NAMESPACES = {
+    'cdas': NS,
+    'xhtml': XHTML_NS
+}
+#
+# For backward compatibility with cdasws versions < 1.8.12.
+#
+from cdasws.cdasws import *

{cdasws-1.8.11 → cdasws-1.8.12}/cdasws/__main__.py

@@ -48,7 +48,7 @@ import logging.config
 from typing import List
 import urllib3
 #import matplotlib.pyplot as plt
-from cdasws import CdasWs
+from cdasws.cdasws import CdasWs
 from cdasws.timeinterval import TimeInterval
 from cdasws.datarequest import GraphOptions, ImageFormat, Overplot, TextFormat
 from cdasws.datarepresentation import DataRepresentation

cdasws-1.8.11/cdasws/__init__.py → cdasws-1.8.12/cdasws/cdasws.py

@@ -32,7 +32,7 @@
 
 
 """
-Package for accessing the Coordinate Data Analysis System (CDAS)
+Module for accessing the Coordinate Data Analysis System (CDAS)
 web services <https://cdaweb.gsfc.nasa.gov/WebServices/REST/>.<br>
 
 Copyright &copy; 2018-2025 United States Government as represented by the
@@ -143,31 +143,7 @@ try:
 except ImportError:
     CACHE_AVAILABLE = False
 
-
-__version__ = "1.8.11"
-
-
-#
-# Limit on the number of times an HTTP request which returns a
-# 429 or 503 status with a Retry-After header will be retried.
-#
-RETRY_LIMIT = 100
-
-#
-# XML schema namespace
-#
-NS = 'http://cdaweb.gsfc.nasa.gov/schema'
-#
-# XHTML schema namespace
-#
-XHTML_NS = 'http://www.w3.org/1999/xhtml'
-#
-# All namespaces found in responses.
-#
-NAMESPACES = {
-    'cdas': NS,
-    'xhtml': XHTML_NS
-}
+from cdasws import __version__, RETRY_LIMIT, NAMESPACES as NS
 
 
 def _get_data_progress(
@@ -389,17 +365,17 @@ class CdasWs:
 
         observatory_group_descriptions = []
         for description in observatory_response.findall(\
-            'cdas:ObservatoryGroupDescription', namespaces=NAMESPACES):
+            'cdas:ObservatoryGroupDescription', namespaces=NS):
 
             observatory_ids = []
             for observatory_id in description.findall(\
-                'cdas:ObservatoryId', namespaces=NAMESPACES):
+                'cdas:ObservatoryId', namespaces=NS):
 
                 observatory_ids.append(observatory_id.text)
 
             observatory_group_descriptions.append({
                 'Name': description.find(\
-                    'cdas:Name', namespaces=NAMESPACES).text,
+                    'cdas:Name', namespaces=NS).text,
                 'ObservatoryId': observatory_ids
             })
 
@@ -464,11 +440,11 @@ class CdasWs:
 
         instrument_types = []
         for description in instrument_response.findall(\
-            'cdas:InstrumentTypeDescription', namespaces=NAMESPACES):
+            'cdas:InstrumentTypeDescription', namespaces=NS):
 
             instrument_types.append({
                 'Name': description.find('cdas:Name',
-                                         namespaces=NAMESPACES).text
+                                         namespaces=NS).text
                 })
         return instrument_types
 
@@ -531,15 +507,15 @@ class CdasWs:
 
         instruments = []
         for instrument_description in instruments_response.findall(\
-            'cdas:InstrumentDescription', namespaces=NAMESPACES):
+            'cdas:InstrumentDescription', namespaces=NS):
 
             instruments.append({
                 'Name': instrument_description.find(\
-                    'cdas:Name', namespaces=NAMESPACES).text,
+                    'cdas:Name', namespaces=NS).text,
                 'ShortDescription': instrument_description.find(\
-                    'cdas:ShortDescription', namespaces=NAMESPACES).text,
+                    'cdas:ShortDescription', namespaces=NS).text,
                 'LongDescription': instrument_description.find(\
-                    'cdas:LongDescription', namespaces=NAMESPACES).text
+                    'cdas:LongDescription', namespaces=NS).text
             })
 
         return instruments
@@ -603,14 +579,14 @@ class CdasWs:
         observatories = []
 
         for observatory in observatory_response.findall(\
-            'cdas:ObservatoryDescription', namespaces=NAMESPACES):
+            'cdas:ObservatoryDescription', namespaces=NS):
             observatories.append({
                 'Name': observatory.find(\
-                    'cdas:Name', namespaces=NAMESPACES).text,
+                    'cdas:Name', namespaces=NS).text,
                 'ShortDescription': observatory.find(\
-                    'cdas:ShortDescription', namespaces=NAMESPACES).text,
+                    'cdas:ShortDescription', namespaces=NS).text,
                 'LongDescription': observatory.find(\
-                    'cdas:LongDescription', namespaces=NAMESPACES).text
+                    'cdas:LongDescription', namespaces=NS).text
             })
 
         return observatories
@@ -670,27 +646,27 @@ class CdasWs:
 
         for o_g_i_d in observatories_response.findall(\
             'cdas:ObservatoryGroupInstrumentDescription',\
-            namespaces=NAMESPACES):
+            namespaces=NS):
 
             o_g_i_d_name = o_g_i_d.find('cdas:Name',
-                                        namespaces=NAMESPACES).text
+                                        namespaces=NS).text
             o_is = []
             for o_i in o_g_i_d.findall('cdas:ObservatoryInstruments',
-                                       namespaces=NAMESPACES):
+                                       namespaces=NS):
 
                 o_i_name = o_i.find('cdas:Name',
-                                    namespaces=NAMESPACES).text
+                                    namespaces=NS).text
                 i_ds = []
                 for i_d in o_i.findall('cdas:InstrumentDescription',
-                                       namespaces=NAMESPACES):
+                                       namespaces=NS):
                     i_d_name = i_d.find('cdas:Name',
-                                        namespaces=NAMESPACES).text
+                                        namespaces=NS).text
                     i_d_short_description = \
                         i_d.find('cdas:ShortDescription',
-                                 namespaces=NAMESPACES).text
+                                 namespaces=NS).text
                     i_d_long_description = \
                          i_d.find('cdas:LongDescription',
-                                  namespaces=NAMESPACES).text
+                                  namespaces=NS).text
                     i_ds.append({
                         'Name': i_d_name,
                         'ShortDescription': i_d_short_description,
@@ -851,74 +827,74 @@ class CdasWs:
 
         datasets = []
         for ds in dss.findall('cdas:DatasetDescription',
-                              namespaces=NAMESPACES):
+                              namespaces=NS):
 
             observatory_groups = []
             for o_g in ds.findall('cdas:ObservatoryGroup',
-                                  namespaces=NAMESPACES):
+                                  namespaces=NS):
                 observatory_groups.append(o_g.text)
 
             instrument_types = []
             for i_t in ds.findall('cdas:InstrumentType',
-                                  namespaces=NAMESPACES):
+                                  namespaces=NS):
                 instrument_types.append(i_t.text)
 
             dataset_links = []
             for d_l in ds.findall('cdas:DatasetLink',
-                                  namespaces=NAMESPACES):
+                                  namespaces=NS):
                 dataset_links.append({
                     'Title': d_l.find('cdas:Title',
-                                      namespaces=NAMESPACES).text,
+                                      namespaces=NS).text,
                     'Text': d_l.find('cdas:Text',
-                                     namespaces=NAMESPACES).text,
+                                     namespaces=NS).text,
                     'Url': d_l.find('cdas:Url',
-                                    namespaces=NAMESPACES).text,
+                                    namespaces=NS).text,
                 })
 
             observatories = []
             for obs_elem in ds.findall('cdas:Observatory',
-                                       namespaces=NAMESPACES):
+                                       namespaces=NS):
                 observatories.append(obs_elem.text)
 
             instruments = []
             for instr_elem in ds.findall('cdas:Instrument',
-                                         namespaces=NAMESPACES):
+                                         namespaces=NS):
                 instruments.append(instr_elem.text)
 
             dataset = {
-                'Id': ds.find('cdas:Id', namespaces=NAMESPACES).text,
+                'Id': ds.find('cdas:Id', namespaces=NS).text,
                 'Observatory': observatories,
                 'Instrument': instruments,
                 'ObservatoryGroup': observatory_groups,
                 'InstrumentType': instrument_types,
                 'Label': ds.find('cdas:Label',
-                                 namespaces=NAMESPACES).text,
+                                 namespaces=NS).text,
                 'TimeInterval': {
                     'Start': ds.find('cdas:TimeInterval/cdas:Start',
-                                     namespaces=NAMESPACES).text,
+                                     namespaces=NS).text,
                     'End': ds.find('cdas:TimeInterval/cdas:End',
-                                   namespaces=NAMESPACES).text
+                                   namespaces=NS).text
                 },
                 'PiName': ds.find('cdas:PiName',
-                                  namespaces=NAMESPACES).text,
+                                  namespaces=NS).text,
                 'PiAffiliation': ds.find('cdas:PiAffiliation',
-                                         namespaces=NAMESPACES).text,
+                                         namespaces=NS).text,
                 'Notes': ds.find('cdas:Notes',
-                                 namespaces=NAMESPACES).text,
+                                 namespaces=NS).text,
                 'DatasetLink': dataset_links
             }
-            doi = ds.find('cdas:Doi', namespaces=NAMESPACES)
+            doi = ds.find('cdas:Doi', namespaces=NS)
             if doi is not None:
                 dataset['Doi'] = doi.text
 
             spase_resource_id = ds.find('cdas:SpaseResourceId',
-                                        namespaces=NAMESPACES)
+                                        namespaces=NS)
             if spase_resource_id is not None:
                 dataset['SpaseResourceId'] = spase_resource_id.text
 
             additional_metadata = []
             for add_meta in ds.findall('cdas:AdditionalMetadata',
-                                       namespaces=NAMESPACES):
+                                       namespaces=NS):
                 meta_type = add_meta.attrib['Type']
                 value = add_meta.text
                 additional_metadata.append({
@@ -1034,16 +1010,16 @@ class CdasWs:
         intervals = []
         for inventory_desc in inventory.findall(\
                                   'cdas:InventoryDescription',
-                                  namespaces=NAMESPACES):
+                                  namespaces=NS):
             for time_interval in inventory_desc.findall(\
                                      'cdas:TimeInterval',
-                                     namespaces=NAMESPACES):
+                                     namespaces=NS):
                 intervals.append(
                     TimeInterval(
                         time_interval.find('cdas:Start',
-                                           namespaces=NAMESPACES).text,
+                                           namespaces=NS).text,
                         time_interval.find('cdas:End',
-                                           namespaces=NAMESPACES).text
+                                           namespaces=NS).text
                     )
                 )
 
@@ -1124,18 +1100,18 @@ class CdasWs:
         variables = []
         for var_description in var_descriptions.findall(\
                                    'cdas:VariableDescription',
-                                   namespaces=NAMESPACES):
+                                   namespaces=NS):
             name = var_description.find('cdas:Name',
-                                        namespaces=NAMESPACES).text
+                                        namespaces=NS).text
             short_description = var_description.find(\
                                         'cdas:ShortDescription',
-                                        namespaces=NAMESPACES).text
+                                        namespaces=NS).text
             if short_description is None:
                 short_description = ''
 
             long_description = var_description.find(\
                                         'cdas:LongDescription',
-                                        namespaces=NAMESPACES).text
+                                        namespaces=NS).text
             if long_description is None:
                 long_description = ''
 
@@ -1194,55 +1170,55 @@ class CdasWs:
         """
         thumbnail_desc = file_description_elem.find(\
                              'cdas:ThumbnailDescription',
-                             namespaces=NAMESPACES)
+                             namespaces=NS)
         if thumbnail_desc is not None:
             time_interval = thumbnail_desc.find('cdas:TimeInterval',
-                                                namespaces=NAMESPACES)
+                                                namespaces=NS)
             start = time_interval.find('cdas:Start',
-                                       namespaces=NAMESPACES).text
+                                       namespaces=NS).text
             end = time_interval.find('cdas:End',
-                                     namespaces=NAMESPACES).text
+                                     namespaces=NS).text
             return {
                 'Name': thumbnail_desc.find('cdas:Name',
-                                            namespaces=NAMESPACES).text,
+                                            namespaces=NS).text,
                 'Dataset': thumbnail_desc.find('cdas:Dataset',
-                                               namespaces=NAMESPACES).text,
+                                               namespaces=NS).text,
                 'TimeInterval': {
                     'Start': start,
                     'End': end
                 },
                 'VarName': thumbnail_desc.find('cdas:VarName',
-                                               namespaces=NAMESPACES).text,
+                                               namespaces=NS).text,
                 'Options': int(thumbnail_desc.find(\
                                    'cdas:Options',
-                                   namespaces=NAMESPACES).text),
+                                   namespaces=NS).text),
                 'NumFrames': int(thumbnail_desc.find(\
                                      'cdas:NumFrames',
-                                     namespaces=NAMESPACES).text),
+                                     namespaces=NS).text),
                 'NumRows': int(thumbnail_desc.find(\
                                    'cdas:NumRows',
-                                   namespaces=NAMESPACES).text),
+                                   namespaces=NS).text),
                 'NumCols': int(thumbnail_desc.find(\
                                    'cdas:NumCols',
-                                   namespaces=NAMESPACES).text),
+                                   namespaces=NS).text),
                 'TitleHeight': int(thumbnail_desc.find(\
                                        'cdas:TitleHeight',
-                                       namespaces=NAMESPACES).text),
+                                       namespaces=NS).text),
                 'ThumbnailHeight': int(thumbnail_desc.find(\
                                            'cdas:ThumbnailHeight',
-                                           namespaces=NAMESPACES).text),
+                                           namespaces=NS).text),
                 'ThumbnailWidth': int(thumbnail_desc.find(\
                                            'cdas:ThumbnailWidth',
-                                           namespaces=NAMESPACES).text),
+                                           namespaces=NS).text),
                 'StartRecord': int(thumbnail_desc.find(\
                                        'cdas:StartRecord',
-                                       namespaces=NAMESPACES).text),
+                                       namespaces=NS).text),
                 'MyScale': float(thumbnail_desc.find(\
                                      'cdas:MyScale',
-                                     namespaces=NAMESPACES).text),
+                                     namespaces=NS).text),
                 'XyStep': float(thumbnail_desc.find(\
                                     'cdas:XyStep',
-                                    namespaces=NAMESPACES).text)
+                                    namespaces=NS).text)
             }
         return None
 
@@ -1268,26 +1244,26 @@ class CdasWs:
         data_result = ET.fromstring(xml_data_result)
         file_descriptions = []
         for file_description in data_result.findall(\
-            'cdas:FileDescription', namespaces=NAMESPACES):
+            'cdas:FileDescription', namespaces=NS):
 
             dict_file_description = {
                 'Name': file_description.find('cdas:Name',
-                                              namespaces=NAMESPACES).text,
+                                              namespaces=NS).text,
                 'MimeType': file_description.find(\
                                 'cdas:MimeType',
-                                namespaces=NAMESPACES).text,
+                                namespaces=NS).text,
                 'StartTime': file_description.find(\
                                  'cdas:StartTime',
-                                 namespaces=NAMESPACES).text,
+                                 namespaces=NS).text,
                 'EndTime': file_description.find(\
                                'cdas:EndTime',
-                               namespaces=NAMESPACES).text,
+                               namespaces=NS).text,
                 'Length': int(file_description.find(\
                                   'cdas:Length',
-                                  namespaces=NAMESPACES).text),
+                                  namespaces=NS).text),
                 'LastModified': file_description.find(\
                                     'cdas:LastModified',
-                                    namespaces=NAMESPACES).text
+                                    namespaces=NS).text
             }
             thumbnail_dict = CdasWs._get_thumbnail_description_dict(\
                                      file_description)
@@ -1297,7 +1273,7 @@ class CdasWs:
 
             thumbnail_id_elem = file_description.find(\
                                     'cdas:ThumbnailId',
-                                    namespaces=NAMESPACES)
+                                    namespaces=NS)
             if thumbnail_id_elem is not None:
                 dict_file_description['ThumbnailId'] = \
                     thumbnail_id_elem.text

{cdasws-1.8.11 → cdasws-1.8.12}/cdasws.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cdasws
-Version: 1.8.11
+Version: 1.8.12
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
@@ -57,6 +57,8 @@ and can return data from any of
 [pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html)
 with all source and 
 [ISTP/SPDF](https://spdf.gsfc.nasa.gov/sp_use_of_cdf.html) metadata.
+Note that this package is included in the [HelioCloud](https://heliocloud.org/)
+base image, so there is no need to install it there.
 Frequently asked questions concerning this library are at 
 [FAQ](https://cdaweb.gsfc.nasa.gov/WebServices/REST/py/FAQ.html).
 For more general details about the CDAS web services, see

{cdasws-1.8.11 → cdasws-1.8.12}/cdasws.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 setup.py
 cdasws/__init__.py
 cdasws/__main__.py
+cdasws/cdasws.py
 cdasws/datarepresentation.py
 cdasws/datarequest.py
 cdasws/timeinterval.py

{cdasws-1.8.11 → cdasws-1.8.12}/setup.py

@@ -10,7 +10,7 @@ README = (HERE / "README.md").read_text()
 # This call to setup() does all the work
 setup(
     name="cdasws",
-    version="1.8.11",
+    version="1.8.12",
     description="NASA's Coordinated Data Analysis System Web Service Client Library",
     long_description=README,
     long_description_content_type="text/markdown",

{cdasws-1.8.11 → cdasws-1.8.12}/tests/test_cdasws.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2019-2024 United States Government as represented by
+# Copyright (c) 2019-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,7 +33,7 @@
 """
 Module for unittest of the CdasWs class.<br>
 
-Copyright &copy; 2019-2024 United States Government as represented by the
+Copyright &copy; 2019-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.
 """
@@ -47,8 +47,7 @@ from typing import Dict
 from context import cdasws  # pylint: disable=unused-import
 
 # pylint: enable=import-error,wrong-import-position
-from cdasws import CdasWs
-#from cdasws.cdasws import CdasWs
+from cdasws.cdasws import CdasWs
 from cdasws.timeinterval import TimeInterval
 from cdasws.datarequest import GraphOptions, ImageFormat, Overplot
 # pylint: enable=import-error,wrong-import-position

{cdasws-1.8.11 → cdasws-1.8.12}/tests/test_timeinterval.py

@@ -43,8 +43,7 @@ from datetime import datetime, timezone
 
 from context import cdasws  # pylint: disable=unused-import
 
-from cdasws import TimeInterval  # pylint: disable=import-error
-#from cdasws.cdasws import TimeInterval  # pylint: disable=import-error
+from cdasws.cdasws import TimeInterval  # pylint: disable=import-error