cdasws 1.8.11__py3-none-any.whl → 1.8.13__py3-none-any.whl

cdasws/datarequest.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2019-2024 United States Government as represented by
+# Copyright (c) 2019-2026 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.
@@ -36,7 +36,7 @@ Package defining classes to represent the DataRequestEntity and its
 sub-classes from
 <https://cdaweb.gsfc.nasa.gov/WebServices/REST/CDAS.xsd>.<br>
 
-Copyright &copy; 2019-2024 United States Government as represented by the
+Copyright &copy; 2019-2026 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.
 """
@@ -350,7 +350,6 @@ class DataRequest(metaclass=ABCMeta): # pylint: disable=too-few-public-methods
             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')
 
 

cdasws/doi.py

@@ -0,0 +1,127 @@
+#!/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) 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.
+#
+
+
+"""
+Module defines utility functions related to Digital Object Identifiers
+(DOI).<br>
+
+Copyright &copy; 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.
+"""
+
+
+def get_canonical_doi(
+        doi: str
+    ) -> str:
+    """
+    Returns a canonical representation (no leading https://doi.org/ and 
+    lower case) Digital Object Identifier (DOI) value.
+
+    Parameters
+    ----------
+    doi
+        digital object identifier.
+    Returns
+    -------
+    str
+        The canonical DOI value.
+    """
+    return doi.replace('https://doi.org/', '').lower()
+
+
+def get_doi_landing_page_url(
+        doi: str
+    ) -> str:
+    """
+    Returns a URL to the given Digital Object Identifier's landing
+    page (metadata for the DOI).
+
+    Parameters
+    ----------
+    doi
+        digital object identifier.
+    Returns
+    -------
+    str
+        A URL to the DOI's landing page.
+    """
+
+    if not doi.startswith('http'):
+        return 'https://doi.org/' + doi
+    return doi
+
+
+def get_doi_badge_url(
+        doi: str
+    ) -> str:
+    """
+    Returns a URL to the given Digital Object Identifier's badge.
+
+    Parameters
+    ----------
+    doi
+        digital object identifier.
+    Returns
+    -------
+    str
+        A URL to the DOI's badge.
+    """
+
+    canonical_doi = get_canonical_doi(doi)
+
+    return 'https://img.shields.io/badge/DOI-' + \
+           canonical_doi.replace('-', '--') + '-blue'
+
+
+def get_doi_hdp_url(
+        doi: str
+    ) -> str:
+    """
+    Returns a URL to the given Digital Object Identifier's Heliophysics
+    Data Portal (HDP) page.
+
+    Parameters
+    ----------
+    doi
+        digital object identifier.
+    Returns
+    -------
+    str
+        A URL to the DOI's HDP page.
+    """
+
+    canonical_doi = get_canonical_doi(doi)
+
+    return 'https://heliophysicsdata.gsfc.nasa.gov/WS/hdp/1/Spase/' \
+           'NumericalData;DisplayData?DOI=' + canonical_doi

{cdasws-1.8.11.dist-info → cdasws-1.8.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cdasws
-Version: 1.8.11
+Version: 1.8.13
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
@@ -16,6 +16,7 @@ Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
@@ -57,6 +58,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.13.dist-info/RECORD

@@ -0,0 +1,14 @@
+cdasws/__init__.py,sha256=Tnc6W-fWhh19fzk9-_xMTO5xndrQaFzEZ_vX-JZ_UgY,2629
+cdasws/__main__.py,sha256=6XEenCcOcxCM9POH2BiTM9z6cnHqZDQU8gZ4Ia7xqoA,13515
+cdasws/cdasws.py,sha256=KN_n2MwfR8QY0nsUxr6fz-3ZMsoIZEvXTC8Kp_QcyeU,91514
+cdasws/datarepresentation.py,sha256=kKgAKCA4uzGoBQ8r8jbXstBg8SCg_EQtsoGhO8kIpco,2164
+cdasws/datarequest.py,sha256=dlAq9H1Tn8COPOWurv3w5wLGWoFNDQXgGQtROlK6zxg,28978
+cdasws/doi.py,sha256=ph0uQ_dM081V4d_uFN1lNCn7-UxHERIyYbTO3JqyqMQ,3172
+cdasws/timeinterval.py,sha256=UcKB-rFSk2eeaw0a29gOQQq7rNY0ab4Qwfz4iwJFelg,7839
+cdasws-1.8.13.dist-info/licenses/LICENSE,sha256=9VDxMcDDn3_T-sDQTMPxmiPZBDkPIiTO4OzYK5olDmk,12589
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/test_cdasws.py,sha256=DsKesU19_9zUIO1a7oyWWtywBGN7gjdQHFLMGUZ4X8c,24395
+cdasws-1.8.13.dist-info/METADATA,sha256=FpNoK_LZ1xdPjaGva7CsAQ7SeQBHuMprYZf2U4BEryI,7107
+cdasws-1.8.13.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
+cdasws-1.8.13.dist-info/top_level.txt,sha256=GyIvHk5F6ysnTdDfnQsjZbTBt_EYrKyC0oeiIt9l-AE,7
+cdasws-1.8.13.dist-info/RECORD,,

{cdasws-1.8.11.dist-info → cdasws-1.8.13.dist-info}/licenses/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.dist-info/RECORD

@@ -1,13 +0,0 @@
-cdasws/__init__.py,sha256=0pB64-kPdpLdMptyZIbyXSZmqADfG6PGwGyIxYmmrv0,92358
-cdasws/__main__.py,sha256=d8GJwd6EJK1JBS71q6h_1LYVUUj1IlRLpylQCi1SRGM,13466
-cdasws/cdasws.py,sha256=755mLWlMFXknNP3f8g_W9An6niAmksqcb1NdgiAybj0,29552
-cdasws/datarepresentation.py,sha256=kKgAKCA4uzGoBQ8r8jbXstBg8SCg_EQtsoGhO8kIpco,2164
-cdasws/datarequest.py,sha256=fQVroT8RXYhJLG7_y-HO3ABnJUQJjWGFPeLNrtwbWtk,29080
-cdasws/timeinterval.py,sha256=UcKB-rFSk2eeaw0a29gOQQq7rNY0ab4Qwfz4iwJFelg,7839
-cdasws-1.8.11.dist-info/licenses/LICENSE,sha256=og42scUY42lPLGBg0wHt6JtrbeInVEr5xojyrguPqrQ,12583
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_cdasws.py,sha256=DsKesU19_9zUIO1a7oyWWtywBGN7gjdQHFLMGUZ4X8c,24395
-cdasws-1.8.11.dist-info/METADATA,sha256=UT8MZ4EYgYEdtEvZZPKwgh0P9NFfT8_ka04emp-HdvQ,6926
-cdasws-1.8.11.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
-cdasws-1.8.11.dist-info/top_level.txt,sha256=GyIvHk5F6ysnTdDfnQsjZbTBt_EYrKyC0oeiIt9l-AE,7
-cdasws-1.8.11.dist-info/RECORD,,