cdasws 1.8.4__tar.gz → 1.8.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdasws
-Version: 1.8.4
+Version: 1.8.5
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris

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

@@ -137,7 +137,7 @@ except ImportError:
         CDF_XARRAY_AVAILABLE = False
 
 
-__version__ = "1.8.4"
+__version__ = "1.8.5"
 
 
 #
@@ -933,6 +933,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,
@@ -1557,8 +1581,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 +1593,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 +1800,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.5}/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.5}/cdasws/datarequest.py

@@ -211,6 +211,7 @@ class CdfFormat(enum.Enum):
     ZIP_CDFML = "ZipCDFML"
     ICDFML = "ICDFML"
     NETCDF = "NetCdf"
+    CDFJSON = "CdfJson"
 
 
 class CdfRequest(DataRequest): # pylint: disable=too-few-public-methods

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdasws
-Version: 1.8.4
+Version: 1.8.5
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris

{cdasws-1.8.4 → cdasws-1.8.5}/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.5",
     description="NASA's Coordinated Data Analysis System Web Service Client Library",
     long_description=README,
     long_description_content_type="text/markdown",