cdasws 1.8.9__tar.gz → 1.8.11__tar.gz

cdasws-1.8.11/LICENSE

@@ -0,0 +1,249 @@
+NASA OPEN SOURCE AGREEMENT VERSION 1.3
+
+THIS OPEN SOURCE AGREEMENT ("AGREEMENT") DEFINES THE RIGHTS OF USE,
+REPRODUCTION, DISTRIBUTION, MODIFICATION AND REDISTRIBUTION OF CERTAIN
+COMPUTER SOFTWARE ORIGINALLY RELEASED BY THE UNITED STATES GOVERNMENT
+AS REPRESENTED BY THE GOVERNMENT AGENCY LISTED BELOW ("GOVERNMENT
+AGENCY").  THE UNITED STATES GOVERNMENT, AS REPRESENTED BY GOVERNMENT
+AGENCY, IS AN INTENDED THIRD-PARTY BENEFICIARY OF ALL SUBSEQUENT
+DISTRIBUTIONS OR REDISTRIBUTIONS OF THE SUBJECT SOFTWARE.  ANYONE WHO
+USES, REPRODUCES, DISTRIBUTES, MODIFIES OR REDISTRIBUTES THE SUBJECT
+SOFTWARE, AS DEFINED HEREIN, OR ANY PART THEREOF, IS, BY THAT ACTION,
+ACCEPTING IN FULL THE RESPONSIBILITIES AND OBLIGATIONS CONTAINED IN
+THIS AGREEMENT.
+
+Government Agency: National Aeronautics and Space Administration (NASA)
+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
+
+
+1. DEFINITIONS
+
+A. "Contributor" means Government Agency, as the developer of the
+Original Software, and any entity that makes a Modification.
+B. "Covered Patents" mean patent claims licensable by a Contributor
+that are necessarily infringed by the use or sale of its Modification
+alone or when combined with the Subject Software.
+C. "Display" means the showing of a copy of the Subject Software,
+either directly or by means of an image, or any other device.
+D. "Distribution" means conveyance or transfer of the Subject
+Software, regardless of means, to another.
+E. "Larger Work" means computer software that combines Subject
+Software, or portions thereof, with software separate from the Subject
+Software that is not governed by the terms of this Agreement.
+F.  "Modification" means any alteration of, including addition to or
+deletion from, the substance or structure of either the Original
+Software or Subject Software, and includes derivative works, as that
+term is defined in the Copyright Statute, 17 USC 101.  However, the
+act of including Subject Software as part of a Larger Work does not in
+and of itself constitute a Modification.
+G. "Original Software" means the computer software first released
+under this Agreement by Government Agency with Government Agency
+designation "GSC-14730-1" and entitled
+"Space Physics Data Facility Web Services", including source code,
+object code and accompanying documentation, if any.
+H. "Recipient" means anyone who acquires the Subject Software under
+this Agreement, including all Contributors.
+I. "Redistribution" means Distribution of the Subject Software after a
+Modification has been made.
+J. "Reproduction" means the making of a counterpart, image or copy of
+the Subject Software.
+K. "Sale" means the exchange of the Subject Software for money or
+equivalent value.
+L. "Subject Software" means the Original Software, Modifications, or
+any respective parts thereof.
+M. "Use" means the application or employment of the Subject Software
+for any purpose.
+
+2. GRANT OF RIGHTS
+
+A. Under Non-Patent Rights: Subject to the terms and conditions of
+this Agreement, each Contributor, with respect to its own contribution
+to the Subject Software, hereby grants to each Recipient a
+non-exclusive, world-wide, royalty-free license to engage in the
+following activities pertaining to the Subject Software:
+
+1. Use
+2. Distribution
+3. Reproduction
+4. Modification
+5. Redistribution
+6. Display
+
+B. Under Patent Rights: Subject to the terms and conditions of this
+Agreement, each Contributor, with respect to its own contribution to
+the Subject Software, hereby grants to each Recipient under Covered
+Patents a non-exclusive, world-wide, royalty-free license to engage in
+the following activities pertaining to the Subject Software:
+
+1. Use
+2. Distribution
+3. Reproduction
+4. Sale
+5. Offer for Sale
+
+C. The rights granted under Paragraph B. also apply to the combination
+of a Contributor's Modification and the Subject Software if, at the
+time the Modification is added by the Contributor, the addition of
+such Modification causes the combination to be covered by the Covered
+Patents.  It does not apply to any other combinations that include a
+Modification.
+
+D. The rights granted in Paragraphs A. and B. allow the Recipient to
+sublicense those same rights.  Such sublicense must be under the same
+terms and conditions of this Agreement.
+
+3. OBLIGATIONS OF RECIPIENT
+
+A. Distribution or Redistribution of the Subject Software must be made
+under this Agreement except for additions covered under paragraph 3H.
+
+1. Whenever a Recipient distributes or redistributes the Subject
+    Software, a copy of this Agreement must be included with each copy
+    of the Subject Software; and
+2. If Recipient distributes or redistributes the Subject Software in
+    any form other than source code, Recipient must also make the
+    source code freely available, and must provide with each copy of
+    the Subject Software information on how to obtain the source code
+    in a reasonable manner on or through a medium customarily used for
+    software exchange.
+
+B. Each Recipient must ensure that the following copyright notice
+appears prominently in the Subject Software:
+
+Copyright (c) 2006 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.
+
+C. Each Contributor must characterize its alteration of the Subject
+Software as a Modification and must identify itself as the originator
+of its Modification in a manner that reasonably allows subsequent
+Recipients to identify the originator of the Modification.  In
+fulfillment of these requirements, Contributor must include a file
+(e.g., a change log file) that describes the alterations made and the
+date of the alterations, identifies Contributor as originator of the
+alterations, and consents to characterization of the alterations as a
+Modification, for example, by including a statement that the
+Modification is derived, directly or indirectly, from Original
+Software provided by Government Agency. Once consent is granted, it
+may not thereafter be revoked.
+
+D. A Contributor may add its own copyright notice to the Subject
+Software.  Once a copyright notice has been added to the Subject
+Software, a Recipient may not remove it without the express permission
+of the Contributor who added the notice.
+
+E. A Recipient may not make any representation in the Subject Software
+or in any promotional, advertising or other material that may be
+construed as an endorsement by Government Agency or by any prior
+Recipient of any product or service provided by Recipient, or that may
+seek to obtain commercial advantage by the fact of Government Agency's
+or a prior Recipient's participation in this Agreement.
+
+F. In an effort to track usage and maintain accurate records of the
+Subject Software, each Recipient, upon receipt of the Subject
+Software, is requested to register with Government Agency by visiting
+the following website: http://opensource.gsfc.nasa.gov/.  Recipient's
+name and personal information shall be used for statistical purposes
+only. Once a Recipient makes a Modification available, it is requested
+that the Recipient inform Government Agency at the web site provided
+above how to access the Modification.
+
+G. Each Contributor represents that that its Modification is believed
+to be Contributor's original creation and does not violate any
+existing agreements, regulations, statutes or rules, and further that
+Contributor has sufficient rights to grant the rights conveyed by this
+Agreement.
+
+H. A Recipient may choose to offer, and to charge a fee for, warranty,
+support, indemnity and/or liability obligations to one or more other
+Recipients of the Subject Software.  A Recipient may do so, however,
+only on its own behalf and not on behalf of Government Agency or any
+other Recipient.  Such a Recipient must make it absolutely clear that
+any such warranty, support, indemnity and/or liability obligation is
+offered by that Recipient alone.  Further, such Recipient agrees to
+indemnify Government Agency and every other Recipient for any
+liability incurred by them as a result of warranty, support, indemnity
+and/or liability offered by such Recipient.
+
+I. A Recipient may create a Larger Work by combining Subject Software
+with separate software not governed by the terms of this agreement and
+distribute the Larger Work as a single product. In such case, the
+Recipient must make sure Subject Software, or portions thereof,
+included in the Larger Work is subject to this Agreement.
+
+J. Notwithstanding any provisions contained herein, Recipient is
+hereby put on notice that export of any goods or technical data from
+the United States may require some form of export license from the
+U.S. Government.  Failure to obtain necessary export licenses may
+result in criminal liability under U.S. laws.  Government Agency
+neither represents that a license shall not be required nor that, if
+required, it shall be issued.  Nothing granted herein provides any
+such export license.
+
+4. DISCLAIMER OF WARRANTIES AND LIABILITIES; WAIVER AND INDEMNIFICATION
+
+A. No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY
+WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY,
+INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE
+WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR FREEDOM FROM
+INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR
+FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO
+THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER,
+CONSTITUTE AN ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT
+OF ANY RESULTS, RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY
+OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT SOFTWARE.
+FURTHER, GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES
+REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE,
+AND DISTRIBUTES IT "AS IS."
+
+B. Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS
+AGAINST THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND
+SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT.  IF RECIPIENT'S USE OF
+THE SUBJECT SOFTWARE RESULTS IN ANY LIABILITIES, DEMANDS, DAMAGES,
+EXPENSES OR LOSSES ARISING FROM SUCH USE, INCLUDING ANY DAMAGES FROM
+PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE OF THE SUBJECT
+SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED
+STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY
+PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW.  RECIPIENT'S SOLE
+REMEDY FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL
+TERMINATION OF THIS AGREEMENT.
+
+
+5. GENERAL TERMS
+
+A. Termination: This Agreement and the rights granted hereunder will
+terminate automatically if a Recipient fails to comply with these
+terms and conditions, and fails to cure such noncompliance within
+thirty (30) days of becoming aware of such noncompliance.  Upon
+termination, a Recipient agrees to immediately cease use and
+distribution of the Subject Software.  All sublicenses to the Subject
+Software properly granted by the breaching Recipient shall survive any
+such termination of this Agreement.
+
+B. Severability: If any provision of this Agreement is invalid or
+unenforceable under applicable law, it shall not affect the validity
+or enforceability of the remainder of the terms of this Agreement.
+
+C. Applicable Law: This Agreement shall be subject to United States
+federal law only for all purposes, including, but not limited to,
+determining the validity of this Agreement, the meaning of its
+provisions and the rights, obligations and remedies of the parties.
+
+D. Entire Understanding: This Agreement constitutes the entire
+understanding and agreement of the parties relating to release of the
+Subject Software and may not be superseded, modified or amended except
+by further written agreement duly executed by the parties.
+
+E. Binding Authority: By accepting and using the Subject Software
+under this Agreement, a Recipient affirms its authority to bind the
+Recipient to all terms and conditions of this Agreement and that that
+Recipient hereby agrees to all terms and conditions herein.
+
+F. Point of Contact: Any Recipient contact with Government Agency is
+to be directed to the designated representative as follows:
+feedback@spdf.gsfc.nasa.gov.

cdasws-1.8.11/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: cdasws
+Version: 1.8.11
+Summary: NASA's Coordinated Data Analysis System Web Service Client Library
+Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
+Author: Bernie Harris
+Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
+License: NOSA
+Keywords: heliophysics,coordinated data analysis,multi-mission,multi-instrument,space physics,spdf,cdaweb
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+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: 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: urllib3>=1.24.1
+Provides-Extra: spdm
+Requires-Dist: spacepy>=0.5.0; extra == "spdm"
+Provides-Extra: xarray
+Requires-Dist: cdflib>=0.4.4; extra == "xarray"
+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
+
+This library provides a simple python interface to the heliophysics data 
+and services of 
+NASA's [Coordinated Data Analysis System](https://cdaweb.gsfc.nasa.gov/)
+(CDAS).  This library implements the client side of the 
+[CDAS RESTful web services](https://cdaweb.gsfc.nasa.gov/WebServices/REST/)
+and can return data from any of 
+[these datasets](https://cdaweb.gsfc.nasa.gov/misc/Notes.html) in a 
+[SpacePy datamodel](https://spacepy.github.io/datamodel.html),
+[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html), or
+[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.
+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
+https://cdaweb.gsfc.nasa.gov/WebServices/REST/.
+
+## Code Example
+
+This package contains example code calling most of the available web services.
+To run the included example, do the following
+
+    python -m cdasws
+
+---
+Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
+different features of the library:
+
+1. [Data Retrieval](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsDataRetrieval.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsDataRetrieval.ipynb)) demonstrating use of library with results returned in [SpacePy data model](https://spacepy.github.io/datamodel.html), [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html), and [pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html). [Launch on Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsDataRetrieval.ipynb).
+2. [CDAWeb Binning Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsBinningExample.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsBinningExample.ipynb)) demonstrating use [CDAWeb binning](https://cdaweb.gsfc.nasa.gov/CDAWeb_Binning_readme.html). [Launch on Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsBinningExample.ipynb).
+3. [Magnetic Field Line Conjunction Example](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.html) ([ipynb file](https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWsConjunctionExample.ipynb)) with related data retrieval/plotting using [cdasws](https://pypi.org/project/cdasws/). [Launch on Binder](https://binder.opensci.2i2c.cloud/v2/gh/berniegsfc/sscws-notebooks/main?labpath=SscWsConjunctionExample.ipynb).
+---
+
+And at the bottom of each 
+[CDAWeb dataset description](https://cdaweb.gsfc.nasa.gov/misc/Notes.html) 
+is a "Data Access Code Examples" link that contains dataset-specific code 
+utilizing this package to access the data.
+
+## Motivation
+
+This library hides the HTTP, JSON/XML, and CDF details of the CDAS web 
+services. A python developer only has to deal with python objects and 
+methods (primarily the SpacePy data model or xarray.Dataset object with 
+full ISTP/SPDF metadata).
+
+## Dependencies
+
+The only required dependencies are the following:
+
+1. [python-dateutil](https://pypi.org/project/python-dateutil/).
+2. [requests](https://pypi.org/project/requests/).
+
+If you call the get_data method then **one** of the following two sets 
+of additional dependencies are required:
+
+1. To have get_data return the data in the SpacePy data model.
+    * [SpacePy](https://spacepy.github.io/). Refer to the SpacePy
+      documentation for the details of SpacePy's dependencies.
+2. To have get_data return the data in an [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html) or [pandas.DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html).
+    * [cdflib](https://pypi.org/project/cdflib/).
+    * [xarray](https://pypi.org/project/xarray/).
+
+If you want to take advantage of HTTP caching, then install the following:
+
+1.  [requests-cache](https://pypi.org/project/requests-cache/).
+
+
+## Installation
+
+As noted in the dependencies above, if you intend to call the get_data
+method, you must install **one** of the following options.
+
+1. [SpacePy](https://spacepy.github.io/).
+
+        $ pip install -U spacepy
+
+2. [cdflib](https://pypi.org/project/cdflib/) and [xarray](https://pypi.org/project/xarray/).
+
+        $ pip install -U cdflib
+        $ pip install -U xarray
+
+Then, to install this package
+
+    $ pip install -U cdasws
+
+or to include the optional cache package
+
+    $ pip install -U cdasws[cache]
+
+
+## API Reference
+
+Refer to
+[cdasws package API reference](https://cdaweb.gsfc.nasa.gov/WebServices/REST/py/cdasws/index.html)
+
+or use the standard python help mechanism.
+
+    from cdasws import CdasWs
+    help(CdasWs)
+
+## Tests
+
+The tests directory contains 
+[unittest](https://docs.python.org/3/library/unittest.html)
+tests.
+
+## Contributors
+
+Bernie Harris.  
+[e-mail](mailto:NASA-SPDF-Support@nasa.onmicrosoft.com) for support.
+
+## License
+
+This code is licensed under the 
+[NASA Open Source Agreement](https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).

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

@@ -48,9 +48,13 @@ full ISTP/SPDF metadata).
 
 ## Dependencies
 
-The only required dependencies are python-dateutil and requests.  If you
-call the get_data method then **one** of the following two sets of additional
-dependencies are required:
+The only required dependencies are the following:
+
+1. [python-dateutil](https://pypi.org/project/python-dateutil/).
+2. [requests](https://pypi.org/project/requests/).
+
+If you call the get_data method then **one** of the following two sets 
+of additional dependencies are required:
 
 1. To have get_data return the data in the SpacePy data model.
     * [SpacePy](https://spacepy.github.io/). Refer to the SpacePy
@@ -59,6 +63,11 @@ dependencies are required:
     * [cdflib](https://pypi.org/project/cdflib/).
     * [xarray](https://pypi.org/project/xarray/).
 
+If you want to take advantage of HTTP caching, then install the following:
+
+1.  [requests-cache](https://pypi.org/project/requests-cache/).
+
+
 ## Installation
 
 As noted in the dependencies above, if you intend to call the get_data
@@ -77,6 +86,10 @@ Then, to install this package
 
     $ pip install -U cdasws
 
+or to include the optional cache package
+
+    $ pip install -U cdasws[cache]
+
 
 ## API Reference
 

{cdasws-1.8.9 → cdasws-1.8.11}/cdasws/__init__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2024 United States Government as represented by
+# 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.
@@ -35,7 +35,7 @@
 Package for accessing the Coordinate Data Analysis System (CDAS)
 web services <https://cdaweb.gsfc.nasa.gov/WebServices/REST/>.<br>
 
-Copyright &copy; 2018-2024 United States Government as represented by the
+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.
 
@@ -102,7 +102,7 @@ try:
 except ImportError:
     try:
         import cdflib as cdf
-        import xarray as xr
+        import xarray as xr   # pylint: disable=ungrouped-imports
         CDF_XARRAY_AVAILABLE = True
         def cdf_to_xarray(filename, to_datetime=False, to_unixtime=False,
                           fillval_to_nan=False):
@@ -130,14 +130,21 @@ except ImportError:
             xarray.dataset
                 An XArray Dataset object.
             """
-            return cdf.cdf_to_xarray(filename, to_datetime=to_datetime,
+            return cdf.cdf_to_xarray(filename, to_datetime=to_datetime, # pylint: disable=no-member
                                      to_unixtime=to_unixtime,
                                      fillval_to_nan=fillval_to_nan)
     except ImportError:
         CDF_XARRAY_AVAILABLE = False
 
 
-__version__ = "1.8.9"
+try:
+    import requests_cache
+    CACHE_AVAILABLE = True
+except ImportError:
+    CACHE_AVAILABLE = False
+
+
+__version__ = "1.8.11"
 
 
 #
@@ -231,7 +238,8 @@ class CdasWs:
             proxy=None,
             ca_certs=None,
             disable_ssl_certificate_validation=False,
-            user_agent=None):
+            user_agent=None,
+            disable_cache=False):
         """
         Creates an object representing the CDAS web services.
 
@@ -259,6 +267,8 @@ class CdasWs:
             Flag indicating whether to validate the SSL certificate.
         user_agent
             A value that is appended to the HTTP User-Agent value.
+        disable_cache
+            Flag indicating whether to disable HTTP caching.
         """
 
         self.logger = logging.getLogger(type(self).__name__)
@@ -268,6 +278,7 @@ class CdasWs:
         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://cdaweb.gsfc.nasa.gov/WS/cdasr/1/dataviews/sp_phys/'
@@ -288,7 +299,12 @@ class CdasWs:
             'User-Agent' : self._user_agent,
             #'Accept-Encoding' : 'gzip'  # only beneficial for icdfml responses
         }
-        self._session = requests.Session()
+        if CACHE_AVAILABLE and disable_cache is not True:
+            self._session = requests_cache.CachedSession('cdasws_cache',
+                                                         cache_control=True)
+        else:
+            self._session = requests.Session()
+
         self._session.headers.update(self._request_headers)
         self._session.auth = NullAuth()
 
@@ -961,7 +977,8 @@ class CdasWs:
 
         url = 'https://doi.org/' + doi
         headers = {'Accept': 'text/x-bibliography; style=apa'}
-        response = requests.get(url, headers=headers)
+        response = requests.get(url, headers=headers,
+                                timeout=30)
 
         return response.text
 

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

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2024 United States Government as represented by
+# 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.
@@ -34,7 +34,7 @@
 Example Coordinate Data Analysis System (CDAS) web service client.
 Includes example calls to most of the web services.
 
-Copyright © 2018-2024 United States Government as represented by the
+Copyright © 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.
 """
@@ -42,6 +42,7 @@ the United States under Title 17, U.S.Code. All Other Rights Reserved.
 import sys
 import getopt
 import json
+import time
 import logging
 import logging.config
 from typing import List
@@ -56,7 +57,7 @@ from cdasws.datarepresentation import DataRepresentation
 logging.basicConfig()
 LOGGING_CONFIG_FILE = 'logging_config.json'
 try:
-    with open(LOGGING_CONFIG_FILE, 'r') as fd:
+    with open(LOGGING_CONFIG_FILE, 'r', encoding='utf-8') as fd:
         logging.config.dictConfig(json.load(fd))
 except BaseException as exc:    # pylint: disable=broad-except
     if not isinstance(exc, FileNotFoundError):
@@ -85,9 +86,10 @@ def print_usage(
     -------
     None
     """
-    print('USAGE: {name} [-e url][-d][-c cacerts][-h]'.format(name=name))
+    print(f'USAGE: {name} [-e url][-d][-c cacerts][-n][-h]')
     print('WHERE: url = CDAS web service endpoint URL')
     print('       -d disables TLS server certificate validation')
+    print('       -n disables the use of http caching')
     print('       cacerts = CA certificate filename')
 
 
@@ -108,13 +110,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])
@@ -125,6 +128,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'):
@@ -134,6 +138,8 @@ 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()
@@ -141,7 +147,8 @@ def example(
 
     cdas = CdasWs(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')
 
     print(cdas.get_observatory_groups(
         instrumentType='Magnetic Fields (Balloon)'))
@@ -163,14 +170,30 @@ def example(
 
     print('citation = ' + cdas.get_citation('10.48322/541v-1f57'))
 
-    mms_brst_inventory = cdas.get_inventory('MMS1_FPI_BRST_L2_DES-MOMS',
+    dataset = 'MMS1_FPI_BRST_L2_DES-MOMS'
+    t0 = time.perf_counter()
+    mms_brst_inventory = cdas.get_inventory(dataset,
                                             timeInterval=TimeInterval(
                                                 '2018-08-30T08:09:53Z',
                                                 '2018-08-30T08:52:00Z'))
-    print('MMS1_FPI_BRST_L2_DES-MOMS inventory:')
+    t1 = time.perf_counter()
+    print(f'{dataset} inventory took {t1 - t0}s')
+    print(f'{dataset} inventory:')
     for interval in mms_brst_inventory:
         print('    ' + str(interval))
 
+    t0 = time.perf_counter()
+    mms_brst_inventory = cdas.get_inventory(dataset,
+                                            timeInterval=TimeInterval(
+                                                '2018-08-30T08:09:53Z',
+                                                '2018-08-30T08:52:00Z'))
+    t1 = time.perf_counter()
+    print(f'second {dataset} inventory took {t1 - t0}s')
+    print(f'second {dataset} inventory:')
+    for interval in mms_brst_inventory:
+        print('    ' + str(interval))
+
+
     doi_inventory = cdas.get_inventory('10.21978/P8T923')
     print('10.21978/P8T923 inventory:')
     for interval in doi_inventory: