cdasws 1.7.42__py3-none-any.whl → 1.7.44__py3-none-any.whl

cdasws/__init__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2022 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.
@@ -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-2022 United States Government as represented by the
+Copyright &copy; 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.
 
@@ -79,14 +79,48 @@ except ImportError:
     SPDM_AVAILABLE = False
 
 try:
-    import cdflib as cdf
+    from cdflib.xarray import cdf_to_xarray
     import xarray as xr
     CDF_XARRAY_AVAILABLE = True
 except ImportError:
-    CDF_XARRAY_AVAILABLE = False
-
-
-__version__ = "1.7.42"
+    try:
+        import cdflib as cdf
+        import xarray as xr
+        CDF_XARRAY_AVAILABLE = True
+        def cdf_to_xarray(filename, to_datetime=False, to_unixtime=False,
+                          fillval_to_nan=False):
+            """
+            Reads a CDF into an xarray.dataset.  This function exists
+            to provide compatility with cdflib >= 1.0.1 for older
+            releases of cdflib.
+
+            Parameters:
+            -----------
+            filename
+                The path to the CDF file to read.
+            to_datetime
+                Whether or not to convert CDF_EPOCH/EPOCH_16/TT2000 to
+                datetime, or leave them as is.
+            to_unixtime
+                Whether or not to convert CDF_EPOCH/EPOCH_16/TT2000 to
+                unixtime, or leave them as is.
+            fillval_to_nan
+                If True, any data values that match the FILLVAL
+                attribute for a variable will be set to NaN.
+
+            Returns
+            -------
+            xarray.dataset
+                An XArray Dataset object.
+            """
+            return cdf.cdf_to_xarray(filename, to_datetime=to_datetime,
+                                     to_unixtime=to_unixtime,
+                                     fillval_to_nan=fillval_to_nan)
+    except ImportError:
+        CDF_XARRAY_AVAILABLE = False
+
+
+__version__ = "1.7.44"
 
 
 #
@@ -1183,15 +1217,16 @@ class CdasWs:
             if SPDM_AVAILABLE:
                 return spdm.fromCDF(filename)
             if CDF_XARRAY_AVAILABLE:
-                return cdf.cdf_to_xarray(filename)
+                return cdf_to_xarray(filename, to_datetime=True,
+                                     fillval_to_nan=True)
             raise ModuleNotFoundError(
                 'neither the spacepy.datamodel nor the cdflib and '
                 'xarray modules are installed')
         if data_representation is DataRepresentation.SPACEPY:
             return spdm.fromCDF(filename)
         if data_representation is DataRepresentation.XARRAY:
-            return cdf.cdf_to_xarray(filename, to_datetime=True,
-                                     fillval_to_nan=True)
+            return cdf_to_xarray(filename, to_datetime=True,
+                                 fillval_to_nan=True)
         return None
 
 
@@ -1224,7 +1259,9 @@ class CdasWs:
         dataset
             dataset identifier of data to get.
         variables
-            array containing names of variables to get.
+            array containing names of variables to get.  The value
+            ALL-VARIABLES may be used instead of specifying all the
+            individual variable names.
         time0
             TimeInterval(s) or start time of data to get.
         time1
@@ -1261,11 +1298,12 @@ class CdasWs:
         Tuple
             [0] contains a dictionary of HTTP and CDAS status information.
             When successful, ['http']['status_code'] will be 200.<br>
-            [1] contains the requested data (SpaceData object) or None.
+            [1] contains the requested data (SpaceData or xarray.Dateset
+            object) or None.
         Raises
         ------
         ValueError
-            If no variables are given or if the given start/end datetime 
+            If no variables are given or if the given start/end datetime
             values are invalid.
         """
         # pylint: disable=too-many-locals
@@ -1800,8 +1838,8 @@ class CdasWs:
             **keywords
         ) -> Tuple[int, Dict]:
         """
-        Gets original data files from a dataset.  Original data files 
-        lack updated meta-data and virtual variable values contained 
+        Gets original data files from a dataset.  Original data files
+        lack updated meta-data and virtual variable values contained
         in files obtained from the `CdasWs.get_data`.  Most callers
         should probably use `CdasWs.get_data` instead of this function.
 

cdasws/__main__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2022 United States Government as represented by
+# Copyright (c) 2018-2023 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-2022 United States Government as represented by the
+Copyright © 2018-2023 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.
 """
@@ -49,7 +49,7 @@ import urllib3
 #import matplotlib.pyplot as plt
 from cdasws import CdasWs
 from cdasws.timeinterval import TimeInterval
-from cdasws.datarequest import GraphOptions, ImageFormat, Overplot
+from cdasws.datarequest import GraphOptions, ImageFormat, Overplot, TextFormat
 from cdasws.datarepresentation import DataRepresentation
 
 
@@ -155,8 +155,9 @@ def example(
     print('Datasets:')
     for dataset in datasets:
         print('  ', dataset['Id'], dataset['Label'])
+        #print('  ', json.dumps(dataset, indent=4))
 
-    print('DOI landing page:', 
+    print('DOI landing page:',
           cdas.get_doi_landing_page_url('10.48322/e0dc-0h53'))
 
     mms_brst_inventory = cdas.get_inventory('MMS1_FPI_BRST_L2_DES-MOMS',
@@ -221,7 +222,7 @@ def example(
         status, data = \
             cdas.get_data('AC_H1_MFI', ['Magnitude', 'BGSEc'],
                           time_intervals,
-                          dataRepresentation = DataRepresentation.XARRAY)
+                          dataRepresentation=DataRepresentation.XARRAY)
 
         if status['http']['status_code'] == 200:
             print(data)
@@ -238,10 +239,12 @@ def example(
         print('pip install', mod)
         print('-----------------------------------------------------------')
 
+
     status, result = \
         cdas.get_graph('AC_H1_MFI', ['Magnitude', 'BGSEc'],
                        '2009-06-01T00:00:00Z', '2009-06-01T00:10:00Z',
                        GraphOptions(coarse_noise_filter=True,
+                                    x_axis_width_factor=4,
                                     y_axis_height_factor=2,
                                     combine=True,
                                     overplot=Overplot.VECTOR_COMPONENTS),
@@ -285,6 +288,7 @@ def example(
     status, result = \
         cdas.get_text('AC_H1_MFI', ['Magnitude', 'BGSEc'],
                       '2009-06-01T00:00:00Z', '2009-06-01T00:10:00Z',
+                      text_format=TextFormat.CSV2
                       #binData={
                       #    'interval': 60.0,
                       #    'interpolateMissingValues': True,
@@ -297,7 +301,6 @@ def example(
     else:
         print('Request failed with status = ', status)
 
-
     status, result = \
         cdas.get_audio('AC_H1_MFI', ['Magnitude', 'BGSEc'],
                        '2009-06-01T00:00:00Z', '2009-06-01T00:10:00Z',

cdasws/datarepresentation.py

@@ -60,5 +60,5 @@ class DataRepresentation(Enum):
 
 #DataRepresentationValue = typing.Literal['SpacePyDm', 'CdfLibXArray']
 
-#assert set(typing.get_args(DataRespresentationValue)) == 
+#assert set(typing.get_args(DataRespresentationValue)) ==
 #   {member.value for member in DataRepresentation}

cdasws/datarequest.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2019-2021 United States Government as represented by
+# Copyright (c) 2019-2023 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-2021 United States Government as represented by the
+Copyright &copy; 2019-2023 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.
 """
@@ -44,7 +44,7 @@ the United States under Title 17, U.S.Code. All Other Rights Reserved.
 
 import enum
 import json
-from typing import Dict, List, Union # when python 3.8 , TypedDict
+from typing import List, Union # when python 3.8 , TypedDict
 from abc import ABCMeta, abstractmethod
 from cdasws.timeinterval import TimeInterval
 
@@ -271,6 +271,8 @@ class TextFormat(enum.Enum):
     """
     PLAIN = "Plain"
     CSV = "CSV"
+    CSV1 = "CSV1"
+    CSV2 = "CSV2"
 
 
 class TextRequest(DataRequest): # pylint: disable=too-few-public-methods
@@ -344,6 +346,10 @@ class GraphOptions:
     coarse_noise_filter
         Use coarse noise filtering to remove values outside 3 deviations
         from mean of all values in the plotted time interval.
+    x_axis_width_factor
+        Multiply the X-axis width for time-series and spectrogram by
+        the given value.  For example, if the standard width is 320
+        pixels and factor is 3, then the width of the X-axis will be 960.
     y_axis_height_factor
         Multiply the Y-axis height for time-series and spectrogram by
         the given value.  For example, if the standard height is 100
@@ -374,12 +380,14 @@ class GraphOptions:
     """
     def __init__(self,
                  coarse_noise_filter: bool = False,
-                 y_axis_height_factor: int = 1,
+                 x_axis_width_factor: int = 3,
+                 y_axis_height_factor: int = 2,
                  combine: bool = False,
                  overplot: Overplot = Overplot.NONE,
                  ):
 
         self._coarse_noise_filter = coarse_noise_filter
+        self._x_axis_width_factor = x_axis_width_factor
         self._y_axis_height_factor = y_axis_height_factor
         self._combine = combine
         self._overplot = overplot
@@ -411,6 +419,32 @@ class GraphOptions:
         self._coarse_noise_filter = value
 
 
+    @property
+    def x_axis_width_factor(self) -> int:
+        """
+        Gets the x_axis_width_factor value.
+
+        Returns
+        -------
+        bool
+            x_axis_width_factor value.
+        """
+        return self._x_axis_width_factor
+
+
+    @x_axis_width_factor.setter
+    def x_axis_width_factor(self, value: int):
+        """
+        Sets the x_axis_width_factor value.
+
+        Parameters
+        ----------
+        value
+            new x_axis_width_factor value.
+        """
+        self._x_axis_width_factor = value
+
+
     @property
     def y_axis_height_factor(self) -> int:
         """
@@ -529,6 +563,8 @@ class GraphRequest(DataRequest): # pylint: disable=too-few-public-methods
             self._data_request['GraphRequest']['GraphOptions'] = {}
             if options.combine:
                 self._data_request['GraphRequest']['GraphOptions']['Combine'] = {}
+            self._data_request['GraphRequest']['GraphOptions']['XAxisWidthFactor'] = \
+                options.x_axis_width_factor
             self._data_request['GraphRequest']['GraphOptions']['YAxisHeightFactor'] = \
                 options.y_axis_height_factor
             if options.coarse_noise_filter:

{cdasws-1.7.42.dist-info → cdasws-1.7.44.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdasws
-Version: 1.7.42
+Version: 1.7.44
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
@@ -31,12 +31,13 @@ Requires-Dist: cdflib (>=0.4.4) ; extra == 'xarray'
 
 ## Synopsis
 
-This library provides a simple python interface to the data and services of 
+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 in the 
-[SpacePy data model](https://pythonhosted.org/SpacePy/datamodel.html) or an
+[SpacePy data model](https://spacepy.github.io/datamodel.html) or an
 [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html)
 with all the original 
 [ISTP/SPDF metadata](https://spdf.gsfc.nasa.gov/sp_use_of_cdf.html).
@@ -55,9 +56,9 @@ To run the included example, do the following
 ---
 Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
 different features of the library:
-1. [Basic Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExample.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExample.ipynb)) demonstrating use of library with results returned in [SpacePy data model](https://spacepy.github.io/datamodel.html).
+1. [Basic Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExample.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExample.ipynb)) demonstrating use of library with results returned in [SpacePy data model](https://spacepy.github.io/datamodel.html). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsExample.ipynb).
 2. [Basic Example](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExampleXarray.html) ([ipynb file](https://cdaweb.gsfc.nasa.gov/WebServices/REST/jupyter/CdasWsExampleXarray.ipynb)) demonstrating use of library with results returned in an [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html). [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/cdasws-notebooks/main?labpath=CdasWsExampleXarray.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/). [Lauch on Binder](https://mybinder.org/v2/gh/berniegsfc/sscws-notebooks/main?labpath=SscWsConjunctionExample.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://mybinder.org/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) 
@@ -77,10 +78,8 @@ 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:
 1. To have get_data return the data in the SpacePy data model.
-    * [SpacePy](https://pythonhosted.org/SpacePy/). Refer to the SpacePy
+    * [SpacePy](https://spacepy.github.io/). Refer to the SpacePy
       documentation for the details of SpacePy's dependencies.
-    * [CDF](https://cdf.gsfc.nasa.gov) which is not (at the time of this 
-      writing) automatically installed with SpacePy.  
 2. To have get_data return the data in an xarray dataset.
     * [cdflib](https://pypi.org/project/cdflib/).
     * [xarray](https://pypi.org/project/xarray/).
@@ -89,12 +88,13 @@ dependencies are required:
 
 As noted in the dependencies above, if you intend to call the get_data
 method, you must install either
-1. [SpacePy](https://pythonhosted.org/SpacePy/) and the 
-   [CDF](https://cdf.gsfc.nasa.gov) library (following the
-   procedures at the SpacePy and CDF web sites).
-2. [cdflib](https://pypi.org/project/cdflib/).
+1. [SpacePy](https://spacepy.github.io/) following the
+   procedures at the SpacePy web sites).
+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
 

cdasws-1.7.44.dist-info/RECORD

@@ -0,0 +1,13 @@
+cdasws/__init__.py,sha256=k0NpyW0EJJrdd3KRPaT1ueprVckOGWiDTafTa-bHJ5w,74559
+cdasws/__main__.py,sha256=sgIqwgEaTto8mJggMAq3UppD6vus5DNQ4fWS3mvxvtY,12411
+cdasws/cdasws.py,sha256=755mLWlMFXknNP3f8g_W9An6niAmksqcb1NdgiAybj0,29552
+cdasws/datarepresentation.py,sha256=kKgAKCA4uzGoBQ8r8jbXstBg8SCg_EQtsoGhO8kIpco,2164
+cdasws/datarequest.py,sha256=DutrESTuL9BVoMRymtVuxN4koXeaRxe9cT-jEoDVK8I,21632
+cdasws/timeinterval.py,sha256=d4i2Q8CtbAX0JdTLTCpyw40r16CycrUQACxhUVogu8E,5664
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/test_cdasws.py,sha256=DsKesU19_9zUIO1a7oyWWtywBGN7gjdQHFLMGUZ4X8c,24395
+cdasws-1.7.44.dist-info/LICENSE,sha256=og42scUY42lPLGBg0wHt6JtrbeInVEr5xojyrguPqrQ,12583
+cdasws-1.7.44.dist-info/METADATA,sha256=omOOl_UfkHCMGwcf8LcqMqGQ6eP502YzNZapOH9ZliI,5695
+cdasws-1.7.44.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+cdasws-1.7.44.dist-info/top_level.txt,sha256=GyIvHk5F6ysnTdDfnQsjZbTBt_EYrKyC0oeiIt9l-AE,7
+cdasws-1.7.44.dist-info/RECORD,,

{cdasws-1.7.42.dist-info → cdasws-1.7.44.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.33.1)
+Generator: bdist_wheel (0.37.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

cdasws-1.7.42.dist-info/RECORD

@@ -1,13 +0,0 @@
-cdasws/__init__.py,sha256=errc5aLqVx7A6gXyfc3z2v-SWlBygnB9IQ2cE6ZDZSw,73010
-cdasws/__main__.py,sha256=tJBAgC5jxq4IdLL8GpSV52kyM3663x4vxmbzomAbGlQ,12241
-cdasws/cdasws.py,sha256=755mLWlMFXknNP3f8g_W9An6niAmksqcb1NdgiAybj0,29552
-cdasws/datarepresentation.py,sha256=DTUq4vz1QiU6086oW3wQhjN789ZkoxxML08dPZNI9Es,2165
-cdasws/datarequest.py,sha256=unkT-0sSQUhhdeUFqwMbZVdBKo14Qz0iF5Q28aFtRSE,20594
-cdasws/timeinterval.py,sha256=d4i2Q8CtbAX0JdTLTCpyw40r16CycrUQACxhUVogu8E,5664
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_cdasws.py,sha256=DsKesU19_9zUIO1a7oyWWtywBGN7gjdQHFLMGUZ4X8c,24395
-cdasws-1.7.42.dist-info/LICENSE,sha256=og42scUY42lPLGBg0wHt6JtrbeInVEr5xojyrguPqrQ,12583
-cdasws-1.7.42.dist-info/METADATA,sha256=nzAXBTBrvOt6OI_Vzx9kg0_Kotu86n0-OT2ctluQlHE,5704
-cdasws-1.7.42.dist-info/WHEEL,sha256=U88EhGIw8Sj2_phqajeu_EAi3RAo8-C6zV3REsWbWbs,92
-cdasws-1.7.42.dist-info/top_level.txt,sha256=GyIvHk5F6ysnTdDfnQsjZbTBt_EYrKyC0oeiIt9l-AE,7
-cdasws-1.7.42.dist-info/RECORD,,