cdasws 1.8.4__tar.gz → 1.8.6__tar.gz

{cdasws-1.8.4 → cdasws-1.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdasws
-Version: 1.8.4
+Version: 1.8.6
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
@@ -118,12 +118,11 @@ Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX
+Classifier: License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
-Provides-Extra: spdm
 Provides-Extra: xarray
+Provides-Extra: spdm

{cdasws-1.8.4 → cdasws-1.8.6}/cdasws/__init__.py

@@ -137,7 +137,7 @@ except ImportError:
         CDF_XARRAY_AVAILABLE = False
 
 
-__version__ = "1.8.4"
+__version__ = "1.8.6"
 
 
 #
@@ -282,7 +282,8 @@ class CdasWs:
             self._user_agent += ' (' + user_agent + ')'
 
         self._request_headers = {
-            'Content-Type' : 'application/json',
+            #'Content-Type' : 'application/json',
+            'Content-Type' : 'application/xml',
             'Accept' : 'application/xml',
             'User-Agent' : self._user_agent,
             #'Accept-Encoding' : 'gzip'  # only beneficial for icdfml responses
@@ -729,17 +730,21 @@ class CdasWs:
             interval.  See module note about timezone value.  If this
             parameter is omitted, the time interval will end infinitely
             in the future.<br>
+            <b>id</b> - a dataset identifier. The value may be a CDAS
+            (e.g., AC_H2_MFI), DOI (e.g., 10.48322/fh85-fj47), or SPASE
+            [ResourceID] (e.g., spase://NASA/NumericalData/ACE/MAG/L2/PT1H)
+            identifier. If specified, all other keywords are ignored.<br>
             <b>idPattern</b> - a java.util.regex compatible regular
-            expression that must match the dataset's identifier value.
+            expression that must match the dataset's CDAS identifier value.
             Omitting this parameter is equivalent to `.*`.<br>
             <b>labelPattern</b> - a java.util.regex compatible regular
-            expression that must match the dataset's  label text.
+            expression that must match the dataset's CDAS label text.
             Omitting this parameter is equivalent to `.*`.  Embedded
             matching flag expressions (e.g., `(?i)` for case insensitive
             match mode) are supported and likely to be useful in this
             case.<br>
             <b>notesPattern</b> - a java.util.regex compatible regular
-            expression that must match the dataset's  notes text.
+            expression that must match the dataset's CDAS notes text.
             Omitting this parameter is equivalent to `.*`.  Embedded
             matching flag expressions (e.g., `(?s)` for dotall match mode)
             are supported and likely to be useful in this case.<br>
@@ -793,6 +798,10 @@ class CdasWs:
             url = url + 'stopDate=' \
                   + urllib.parse.quote(keywords['stopDate']) + '&'
 
+        if 'id' in keywords:
+            url = url + 'id=' \
+                  + urllib.parse.quote(keywords['id']) + '&'
+
         if 'idPattern' in keywords:
             url = url + 'idPattern=' \
                   + urllib.parse.quote(keywords['idPattern']) + '&'
@@ -933,6 +942,30 @@ class CdasWs:
         return doi
 
 
+    @staticmethod
+    def get_citation(
+            doi: str
+        ) -> str:
+        """
+        Returns the citation from doi.org for the given DOI.
+
+        Parameters
+        ----------
+        doi
+            digital object identifier.
+        Returns
+        -------
+        str
+            The citation from doi.org for the given DOI.
+        """
+
+        url = 'https://doi.org/' + doi
+        headers = {'Accept': 'text/x-bibliography; style=apa'}
+        response = requests.get(url, headers=headers)
+
+        return response.text
+
+
     def get_inventory(
             self,
             identifier: str,
@@ -1305,7 +1338,8 @@ class CdasWs:
         url = self._endpoint + 'datasets'
 
         for retries in range(RETRY_LIMIT):
-            response = self._session.post(url, data=data_request.json(),
+            #response = self._session.post(url, data=data_request.json(),
+            response = self._session.post(url, data=data_request.xml_str(),
                                           timeout=self._timeout)
 
             if response.status_code == 200:
@@ -1557,8 +1591,8 @@ class CdasWs:
             If an Exception is raise by either the spdm.fromCDF() or
             cdflib.cdf_to_xarray() functions.
         ModuleNotFoundError
-            If neither the spacepy.datamodel nor the cdflib and xarray
-            modules are installed.
+            If the required spacepy.datamodel or the cdflib and xarray
+            modules are not installed.
         """
         if data_representation is None:
             if SPDM_AVAILABLE:
@@ -1569,6 +1603,14 @@ class CdasWs:
             raise ModuleNotFoundError(
                 'neither the spacepy.datamodel nor the cdflib and '
                 'xarray modules are installed')
+
+        if data_representation is DataRepresentation.SPACEPY and \
+           not SPDM_AVAILABLE:
+            raise ModuleNotFoundError('spacepy module must be installed')
+        if data_representation is DataRepresentation.XARRAY and \
+           not CDF_XARRAY_AVAILABLE:
+            raise ModuleNotFoundError('cdflib and xarray modules must be installed')
+
         if data_representation is DataRepresentation.SPACEPY:
             return spdm.fromCDF(filename)
         if data_representation is DataRepresentation.XARRAY:
@@ -1768,8 +1810,9 @@ class CdasWs:
                                      progress_user_value) != 0:
                     return (status, None)
         except:
-            self.logger.error('Exception from read_data(%s): %s',
-                              tmp_filename, sys.exc_info()[0])
+            self.logger.error('Exception from read_data(%s): %s, %s',
+                              tmp_filename, sys.exc_info()[0],
+                              sys.exc_info()[1])
             self.logger.error('CDF file has been retained.')
             raise
         return (status, data)

{cdasws-1.8.4 → cdasws-1.8.6}/cdasws/__main__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2023 United States Government as represented by
+# Copyright (c) 2018-2024 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 Coordinate Data Analysis System (CDAS) web service client.
 Includes example calls to most of the web services.
 
-Copyright © 2018-2023 United States Government as represented by the
+Copyright © 2018-2024 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.
 """
@@ -138,6 +138,7 @@ def example(
             print_usage(argv[0])
             sys.exit()
 
+
     cdas = CdasWs(endpoint=endpoint, ca_certs=ca_certs,
                   disable_ssl_certificate_validation=
                   disable_ssl_certificate_validation, user_agent='Example')
@@ -160,6 +161,8 @@ def example(
     print('DOI landing page:',
           cdas.get_doi_landing_page_url('10.48322/e0dc-0h53'))
 
+    print('citation = ' + cdas.get_citation('10.48322/541v-1f57'))
+
     mms_brst_inventory = cdas.get_inventory('MMS1_FPI_BRST_L2_DES-MOMS',
                                             timeInterval=TimeInterval(
                                                 '2018-08-30T08:09:53Z',
@@ -200,6 +203,7 @@ def example(
                           #    'sigmaMultiplier': 4,
                           #    'overrideDefaultBinning': True
                           #}
+                          dataRepresentation=DataRepresentation.SPACEPY
                           )
 #            cdas.get_data('10.21978/P8PG8V', ['BT'],
 #                          '1987-09-24T00:00:00Z', '1987-09-24T01:00:00Z'

{cdasws-1.8.4 → cdasws-1.8.6}/cdasws/datarequest.py

@@ -44,8 +44,10 @@ the United States under Title 17, U.S.Code. All Other Rights Reserved.
 
 import enum
 import json
+import xml.etree.ElementTree as ET
 from typing import List, Union # when python 3.8 , TypedDict
 from abc import ABCMeta, abstractmethod
+#from cdasws import NS
 from cdasws.timeinterval import TimeInterval
 
 
@@ -117,6 +119,14 @@ class DataRequest(metaclass=ABCMeta): # pylint: disable=too-few-public-methods
         Creates an object representing a DataRequestEntity from
         <https://cdaweb.gsfc.nasa.gov/WebServices/REST/CDAS.xsd>.
 
+        Notes
+        -----
+        This class was originally written with serialization to JSON
+        in mind so some dict key values are the JSON representations.
+        For example, Start/End key values are strings instead of
+        datetimes.  These value data type choices cause extra code
+        for serialization to XML.
+
         Parameters
         ----------
         request_type
@@ -180,6 +190,170 @@ class DataRequest(metaclass=ABCMeta): # pylint: disable=too-few-public-methods
                     bin_data['overrideDefaultBinning']
 
 
+    # pylint: disable=too-many-locals
+    # pylint: disable=too-many-branches
+    # pylint: disable=too-many-statements
+    def xml_element(self) -> ET:
+        """
+        Produces the XML Element representation of this object.
+
+        Returns
+        -------
+        ET
+            XML Element representation of this object.
+        """
+
+        #attrs = {'xmlns': NS}
+        attrs = {'xmlns': 'http://cdaweb.gsfc.nasa.gov/schema'}
+
+        builder = ET.TreeBuilder()
+        builder.start('DataRequest', attrs)
+        request_name = next(iter(self._data_request))
+        builder.start(request_name, {})
+        data_request = self._data_request[request_name]
+        time_intervals = data_request['TimeInterval']
+        if isinstance(time_intervals, list):
+            for time_interval in time_intervals:
+                start = time_interval['Start']
+                end = time_interval['End']
+                TimeInterval(start, end).xml_element(builder)
+        else:
+            start = time_intervals['Start']
+            end = time_intervals['End']
+            TimeInterval(start, end).xml_element(builder)
+
+        builder.start('DatasetRequest', {})
+        dataset_request = data_request['DatasetRequest']
+        builder.start('DatasetId', {})
+        builder.data(dataset_request['DatasetId'])
+        builder.end('DatasetId')
+        variable_names = dataset_request['VariableName']
+        if isinstance(variable_names, list):
+            for variable_name in variable_names:
+                builder.start('VariableName', {})
+                builder.data(variable_name)
+                builder.end('VariableName')
+        else:
+            builder.start('VariableName', {})
+            builder.data(variable_names)
+            builder.end('VariableName')
+        builder.end('DatasetRequest')
+        if 'CdfVersion' in data_request:
+            builder.start('CdfVersion', {})
+            builder.data(str(data_request['CdfVersion']))
+            builder.end('CdfVersion')
+        if 'CdfFormat' in data_request:
+            builder.start('CdfFormat', {})
+            builder.data(data_request['CdfFormat'])
+            builder.end('CdfFormat')
+        if 'Compression' in data_request:
+            builder.start('Compression', {})
+            builder.data(data_request['Compression'])
+            builder.end('Compression')
+        if 'Format' in data_request:
+            builder.start('Format', {})
+            builder.data(data_request['Format'])
+            builder.end('Format')
+        if 'Thumbnail' in data_request:
+            builder.start('Thumbnail', {})
+            builder.data(str(data_request['Thumbnail']))
+            builder.end('Thumbnail')
+        if 'ThumbnailId' in data_request:
+            builder.start('ThumbnailId', {})
+            builder.data(data_request['ThumbnailId'])
+            builder.end('ThumbnailId')
+        if 'GraphOptions' in data_request:
+            graph_options = data_request['GraphOptions']
+            builder.start('GraphOptions', {})
+            if 'CoarseNoiseFilter' in graph_options:
+                builder.start('CoarseNoiseFilter', {})
+                builder.data(graph_options['CoarseNoiseFilter'])
+                builder.end('CoarseNoiseFilter')
+            if 'XAxisWidthFactor' in graph_options:
+                builder.start('XAxisWidthFactor', {})
+                builder.data(str(graph_options['XAxisWidthFactor']))
+                builder.end('XAxisWidthFactor')
+            if 'YAxisHeightFactor' in graph_options:
+                builder.start('YAxisHeightFactor', {})
+                builder.data(str(graph_options['YAxisHeightFactor']))
+                builder.end('YAxisHeightFactor')
+            if 'Combine' in graph_options:
+                builder.start('Combine', {})
+                builder.data(str(graph_options['Combine']).lower())
+                builder.end('Combine')
+            if 'Overplot' in graph_options:
+                builder.start('Overplot', {})
+                builder.data(str(graph_options['Overplot']))
+                builder.end('Overplot')
+            builder.end('GraphOptions')
+        if 'GraphOption' in data_request:
+            graph_options = data_request['GraphOption']
+            if isinstance(graph_options, list):
+                for graph_option in graph_options:
+                    builder.start('GraphOption', {})
+                    builder.data(graph_option)
+                    builder.end('GraphOption')
+            else:
+                builder.start('GraphOption', {})
+                builder.data(graph_option)
+                builder.end('GraphOption')
+        if 'ImageFormat' in data_request:
+            image_formats = data_request['ImageFormat']
+            if isinstance(image_formats, list):
+                for image_format in image_formats:
+                    builder.start('ImageFormat', {})
+                    builder.data(image_format)
+                    builder.end('ImageFormat')
+            else:
+                builder.start('ImageFormat', {})
+                builder.data(data_request['ImageFormat'])
+                builder.end('ImageFormat')
+        if 'BinData' in data_request:
+            bin_data = data_request['BinData']
+            builder.start('BinData')
+            if 'Interval' in bin_data:
+                builder.start('Interval', {})
+                builder.data(str(bin_data['Interval']))
+                builder.end('Interval')
+            if 'InterpolateMissingValues' in bin_data:
+                builder.start('InterpolateMissingValues', {})
+                builder.data(str(bin_data['InterpolateMissingValues']).lower())
+                builder.end('InterpolateMissingValues')
+            if 'SigmaMultiplier' in bin_data:
+                builder.start('SigmaMultiplier', {})
+                builder.data(str(bin_data['SigmaMultiplier']))
+                builder.end('SigmaMultiplier')
+            if 'OverrideDefaultBinning' in bin_data:
+                builder.start('OverrideDefaultBinning', {})
+                builder.data(str(bin_data['OverrideDefaultBinning']).lower())
+                builder.end('OverrideDefaultBinning')
+            builder.end('BinData')
+        builder.end(request_name)
+        builder.end('DataRequest')
+        xml_element = builder.close()
+
+        return xml_element
+    # pylint: enable=too-many-locals
+    # pylint: enable=too-many-branches
+    # pylint: enable=too-many-statements
+
+
+    def xml_str(self) -> str:
+        """
+        Produces an str xml representation of this object matching the
+        XML representation of a DataRequestEntity from
+        <https://cdaweb.gsfc.nasa.gov/WebServices/REST/CDAS.xsd>.
+
+        Returns
+        -------
+        str
+            string XML representation of this object.
+        """
+
+        #return ET.tostring(self.xml_element(), encoding="utf-8", method='xml', xml_declaration=True)
+        return ET.tostring(self.xml_element(), encoding="utf-8", method='xml')
+
+
     def json(self, **keywords) -> str:
         """
         Produces a JSON representation of this object matching the
@@ -211,6 +385,7 @@ class CdfFormat(enum.Enum):
     ZIP_CDFML = "ZipCDFML"
     ICDFML = "ICDFML"
     NETCDF = "NetCdf"
+    CDFJSON = "CdfJson"
 
 
 class CdfRequest(DataRequest): # pylint: disable=too-few-public-methods
@@ -631,6 +806,7 @@ class ThumbnailRequest(DataRequest): # pylint: disable=too-few-public-methods
                     i_format.value)
 
 
+
 class AudioRequest(DataRequest): # pylint: disable=too-few-public-methods
     """
     Class representing an AudioRequest from

{cdasws-1.8.4 → cdasws-1.8.6}/cdasws/timeinterval.py

@@ -41,6 +41,8 @@ the United States under Title 17, U.S.Code. All Other Rights Reserved.
 """
 
 
+import xml.etree.ElementTree as ET
+from xml.etree.ElementTree import TreeBuilder
 from datetime import datetime, timezone
 from typing import Tuple, Union
 import dateutil.parser
@@ -132,6 +134,53 @@ class TimeInterval:
         self._end = TimeInterval.get_datetime(value)
 
 
+    def xml_element(self,
+                    builder: TreeBuilder = None) -> ET:
+        """
+        Produces the XML Element representation of this object.
+
+        Parameters
+        ----------
+        builder
+            The TreeBuilder to use.
+
+        Returns
+        -------
+        ET
+            XML Element representation of this object.
+        """
+
+        if builder is None:
+            builder = ET.TreeBuilder()
+
+        builder.start('TimeInterval', {})
+        builder.start('Start', {})
+        builder.data(self._start.isoformat().replace('+00:00', '.000Z'))
+        builder.end('Start')
+        builder.start('End', {})
+        builder.data(self._end.isoformat().replace('+00:00', '.000Z'))
+        builder.end('End')
+
+        return builder.end('TimeInterval')
+
+
+    def xml_str(self) -> str:
+        """
+        Produces an str xml representation of this object matching the
+        XML representation of a DataRequestEntity from
+        <https://cdaweb.gsfc.nasa.gov/WebServices/REST/CDAS.xsd>.
+
+        Returns
+        -------
+        str
+            string XML representation of this object.
+        """
+
+        #return ET.tostring(self.xml_element(), encoding="utf-8", method='xml',
+        #                   xml_declaration=True)
+        return ET.tostring(self.xml_element(), encoding="utf-8", method='xml')
+
+
     def __str__(self):
         return self._start.isoformat() + ' ' + self._end.isoformat()
 

{cdasws-1.8.4 → cdasws-1.8.6}/cdasws.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdasws
-Version: 1.8.4
+Version: 1.8.6
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
@@ -118,12 +118,11 @@ Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX
+Classifier: License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
-Provides-Extra: spdm
 Provides-Extra: xarray
+Provides-Extra: spdm

{cdasws-1.8.4 → cdasws-1.8.6}/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.4",
+    version="1.8.6",
     description="NASA's Coordinated Data Analysis System Web Service Client Library",
     long_description=README,
     long_description_content_type="text/markdown",
@@ -37,10 +37,8 @@ setup(
         "Intended Audience :: End Users/Desktop",
         "Intended Audience :: Developers",
         "Intended Audience :: System Administrators",
-#        "License :: OSI Approved :: NASA Open Source Agreement",
-        "Operating System :: MacOS :: MacOS X",
-        "Operating System :: Microsoft :: Windows",
-        "Operating System :: POSIX",
+        "License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)",
+        "Operating System :: OS Independent",
         "Programming Language :: Python",
         "Topic :: Scientific/Engineering :: Physics",
         "Topic :: Software Development :: Libraries :: Python Modules"