sparclclient 1.2.6b13__py2.py3-none-any.whl → 1.2.7b1__py2.py3-none-any.whl

sparcl/__init__.py

@@ -35,4 +35,5 @@ __all__ = ["client", "align_records"]
 #__version__ = "1.2.3"
 #__version__ = "1.2.4"
 #__version__ = "1.2.5"
-__version__ = "1.2.6b13"
+#__version__ = "1.2.6"
+__version__ = "1.2.7b1"

sparcl/client.py

@@ -163,7 +163,7 @@ class SparclClient:  # was SparclApi()
             Defaults to True.
 
     Example:
-        >>> client = SparclClient()
+        >>> client = SparclClient(announcement=False)
 
     Raises:
         Exception: Object creation compares the version from the
@@ -199,7 +199,8 @@ class SparclClient:  # was SparclApi()
         #!self.internal_names = internal_names
         self.c_timeout = min(MAX_CONNECT_TIMEOUT,
                              float(connect_timeout))  # seconds
-        self.r_timeout = min(MAX_READ_TIMEOUT, float(read_timeout))  # seconds
+        self.r_timeout = min(MAX_READ_TIMEOUT,
+                             float(read_timeout))  # seconds
 
         # require response within this num seconds
         # https://2.python-requests.org/en/master/user/advanced/#timeouts
@@ -214,7 +215,7 @@ class SparclClient:  # was SparclApi()
         if announcement:
             ann = f"{self.apiurl}/announcement/"
             annres = requests.get(ann, timeout=self.timeout)
-            annstr = annres.json()['announcement']
+            annstr = annres.json()["announcement"]
             if annstr:
                 print(f"announcement={annstr}")
 
@@ -308,7 +309,7 @@ class SparclClient:  # was SparclApi()
 
         Example:
             >>>
-            >> client = SparclClient()
+            >> client = SparclClient(announcement=False)
             >> client.login('test_user@noirlab.edu', 'testpw')
             Logged in successfully with email='test_user@noirlab.edu'
         """
@@ -343,8 +344,8 @@ class SparclClient:  # was SparclApi()
             self.renew_token = None
             self.token_exp = None
             msg = (
-                'Could not login with given credentials. '
-                'Reverted to "Anonymous" user.'
+                'Could not login with given credentials. Reverted '
+                'to "Anonymous" user.'
             )
             return msg
 
@@ -372,7 +373,7 @@ class SparclClient:  # was SparclApi()
             None.
 
         Example:
-            >>> client = SparclClient()
+            >>> client = SparclClient(announcement=False)
             >>> client.logout()
             Logged-out successfully.  Previously logged-in with email None.
         """
@@ -412,16 +413,16 @@ class SparclClient:  # was SparclApi()
         parameter of client.retrieve().
 
         Args:
-            dataset_list (:obj:`list` of :obj:`str`, optional): List of
-                data sets from which to get the default fields. Defaults
-                to None, which will return the intersection of default
-                fields in all data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list`, optional): List of data sets from
+                which to get the default fields. Defaults to None, which
+                will return the intersection of default fields in all
+                data sets hosted on the SPARCL database.
 
         Returns:
             List of fields tagged as 'default' from DATASET_LIST.
 
         Example:
-            >>> client = SparclClient()
+            >>> client = SparclClient(announcement=False)
             >>> client.get_default_fields()
             ['dec', 'flux', 'ra', 'sparcl_id', 'specid', 'wavelength']
         """
@@ -443,16 +444,16 @@ class SparclClient:  # was SparclApi()
         of client.retrieve().
 
         Args:
-            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
-                sets from which to get all fields. Defaults to None, which
-                will return the intersection of all fields in all data sets
-                hosted on the SPARCL database.
+            dataset_list (:obj:`list`, optional): List of data sets from
+                which to get all fields. Defaults to None, which
+                will return the intersection of all fields in all
+                data sets hosted on the SPARCL database.
 
         Returns:
             List of fields tagged as 'all' from DATASET_LIST.
 
         Example:
-            >>> client = SparclClient()
+            >>> client = SparclClient(announcement=False)
             >>> client.get_all_fields()
             ['data_release', 'datasetgroup', 'dateobs', 'dateobs_center', 'dec', 'exptime', 'flux', 'instrument', 'ivar', 'mask', 'model', 'ra', 'redshift', 'redshift_err', 'redshift_warning', 'site', 'sparcl_id', 'specid', 'specprimary', 'spectype', 'survey', 'targetid', 'telescope', 'wave_sigma', 'wavelength', 'wavemax', 'wavemin']
         """  # noqa: E501
@@ -500,16 +501,16 @@ class SparclClient:  # was SparclApi()
         client.retreive().
 
         Args:
-            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
-                sets from which to get available fields. Defaults to None,
-                which will return the intersection of all available fields
-                in all data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list`, optional): List of data sets from
+                which to get available fields. Defaults to None, which
+                will return the intersection of all available fields in
+                all data sets hosted on the SPARCL database.
 
         Returns:
             Set of fields available from data sets in DATASET_LIST.
 
         Example:
-            >>> client = SparclClient()
+            >>> client = SparclClient(announcement=False)
             >>> sorted(client.get_available_fields())
             ['data_release', 'datasetgroup', 'dateobs', 'dateobs_center', 'dec', 'exptime', 'extra_files', 'file', 'flux', 'instrument', 'ivar', 'mask', 'model', 'ra', 'redshift', 'redshift_err', 'redshift_warning', 'site', 'sparcl_id', 'specid', 'specprimary', 'spectype', 'survey', 'targetid', 'telescope', 'updated', 'wave_sigma', 'wavelength', 'wavemax', 'wavemin']
 
@@ -529,7 +530,7 @@ class SparclClient:  # was SparclApi()
             API version (:obj:`float`).
 
         Example:
-            >>> client = SparclClient()
+            >>> client = SparclClient(announcement=False)
             >>> client.version
             12.0
         """
@@ -556,10 +557,10 @@ class SparclClient:  # was SparclApi()
         """Find records in the SPARCL database.
 
         Args:
-            outfields (:obj:`list` of :obj:`str`, optional): List of
-                fields to return. Only CORE fields may be passed to
-                this parameter. Defaults to None, which will return
-                only the sparcl_id and _dr fields.
+            outfields (:obj:`list`, optional): List of fields to return.
+                Only CORE fields may be passed to this parameter.
+                Defaults to None, which will return only the sparcl_id
+                and _dr fields.
 
             constraints (:obj:`dict`, optional): Key-Value pairs of
                 constraints to place on the record selection. The Key
@@ -582,7 +583,7 @@ class SparclClient:  # was SparclApi()
             :class:`~sparcl.Results.Found`: Contains header and records.
 
         Example:
-            >>> client = SparclClient()
+            >>> client = SparclClient(announcement=False)
             >>> outs = ['sparcl_id', 'ra', 'dec']
             >>> cons = {'spectype': ['GALAXY'], 'redshift': [0.5, 0.9]}
             >>> found = client.find(outfields=outs, constraints=cons)
@@ -642,17 +643,22 @@ class SparclClient:  # was SparclApi()
         return found
 
     def missing(
-        self, uuid_list, *, dataset_list=None, countOnly=False, verbose=False
+        self,
+        uuid_list,
+        *,
+        dataset_list=None,
+        countOnly=False,
+        verbose=False
     ):
         """Return the subset of sparcl_ids in the given uuid_list that are
         NOT stored in the SPARCL database.
 
         Args:
-            uuid_list (:obj:`list` of :obj:`str`): List of sparcl_ids.
+            uuid_list (:obj:`list`): List of sparcl_ids.
 
-            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
-                sets from which to find missing sparcl_ids. Defaults to None,
-                meaning all data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list`, optional): List of data sets from
+                which to find missing sparcl_ids. Defaults to None, meaning
+                all data sets hosted on the SPARCL database.
 
             countOnly (:obj:`bool`, optional): Set to True to return only
                 a count of the missing sparcl_ids from the uuid_list.
@@ -666,9 +672,9 @@ class SparclClient:  # was SparclApi()
             are NOT stored in the SPARCL database.
 
         Example:
-            >>> client = SparclClient()
-            >>> sparcl_ids = ['ddbb57ee-8e90-4a0d-823b-0f5d97028076',]
-            >>> client.missing(uuid_list=sparcl_ids)
+            >>> client = SparclClient(announcement=False)
+            >>> ids = ['ddbb57ee-8e90-4a0d-823b-0f5d97028076',]
+            >>> client.missing(ids)
             ['ddbb57ee-8e90-4a0d-823b-0f5d97028076']
         """
 
@@ -703,11 +709,11 @@ class SparclClient:  # was SparclApi()
         NOT stored in the SPARCL database.
 
         Args:
-            specid_list (:obj:`list` of :obj:`int`): List of specids.
+            specid_list (:obj:`list`): List of specids.
 
-            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
-                sets from which to find missing specids. Defaults to None,
-                meaning all data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list`, optional): List of data sets from
+                which to find missing specids. Defaults to None, meaning
+                all data sets hosted on the SPARCL database.
 
             countOnly (:obj:`bool`, optional): Set to True to return only
                 a count of the missing specids from the specid_list.
@@ -721,10 +727,11 @@ class SparclClient:  # was SparclApi()
             are NOT stored in the SPARCL database.
 
         Example:
-            >>> client = SparclClient()
-            >>> specids = [398913623742323421, 6181239242670493696]
-            >>> client.missing_specids(specid_list=specids)
-            [398913623742323421]
+            >>> client = SparclClient(announcement=False)
+            >>> found = client.find(outfields=['specid'], limit=2)
+            >>> specids = [f.specid for f in found.records]
+            >>> client.missing_specids(specids + ['6802933904984788992'])
+            ['6802933904984788992']
         """
         if dataset_list is None:
             dataset_list = self.fields.all_drs
@@ -790,15 +797,15 @@ class SparclClient:  # was SparclApi()
         sparcl_ids.
 
         Args:
-            uuid_list (:obj:`list` of :obj:`str`): List of sparcl_ids.
+            uuid_list (:obj:`list`): List of sparcl_ids.
 
-            include (:obj:`list` of :obj:`str`, optional): List of field
-                names to include in each record. Defaults to 'DEFAULT',
-                which will return the fields tagged as 'default'.
+            include (:obj:`list`, optional): List of field names to include
+                in each record. Defaults to 'DEFAULT', which will return
+                the fields tagged as 'default'.
 
-            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
-                sets from which to retrieve spectra data. Defaults to None,
-                meaning all data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list`, optional): List of data sets from
+                which to retrieve spectra data. Defaults to None, meaning all
+                data sets hosted on the SPARCL database.
 
             limit (:obj:`int`, optional): Maximum number of records to
                 return. Defaults to 500. Maximum allowed is 24,000.
@@ -810,7 +817,7 @@ class SparclClient:  # was SparclApi()
             :class:`~sparcl.Results.Retrieved`: Contains header and records.
 
         Example:
-            >>> client = SparclClient()
+            >>> client = SparclClient(announcement=False)
             >>> ids = client.find(limit=1).ids
             >>> inc = ['sparcl_id', 'flux', 'wavelength', 'model']
             >>> ret = client.retrieve(uuid_list=ids, include=inc)
@@ -993,15 +1000,15 @@ class SparclClient:  # was SparclApi()
         specids.
 
         Args:
-            specid_list (:obj:`list` of :obj:`int`): List of specids.
+            specid_list (:obj:`list`): List of specids.
 
-            include (:obj:`list` of :obj:`str`, optional): List of field
-                names to include in each record. Defaults to 'DEFAULT',
-                which will return the fields tagged as 'default'.
+            include (:obj:`list`, optional): List of field names to include
+                in each record. Defaults to 'DEFAULT', which will return
+                the fields tagged as 'default'.
 
-            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
-                sets from which to retrieve spectra data. Defaults to None,
-                meaning all data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list`, optional): List of data sets from
+                which to retrieve spectra data. Defaults to None, meaning all
+                data sets hosted on the SPARCL database.
 
             limit (:obj:`int`, optional): Maximum number of records to
                 return. Defaults to 500. Maximum allowed is 24,000.
@@ -1013,7 +1020,7 @@ class SparclClient:  # was SparclApi()
             :class:`~sparcl.Results.Retrieved`: Contains header and records.
 
         Example:
-            >>> client = SparclClient()
+            >>> client = SparclClient(announcement=False)
             >>> sids = [5840097619402313728, -8985592895187431424]
             >>> inc = ['specid', 'flux', 'wavelength', 'model']
             >>> ret = client.retrieve_by_specid(specid_list=sids, include=inc)
@@ -1052,9 +1059,9 @@ class SparclClient:  # was SparclApi()
             usrcount = len(specid_list)
             dbcount = found.count
             warn = (
-                f"UserWarning: Some specIDs were not found. "
+                f"UserWarning: Some SPECIDs were not found. "
                 f"{usrcount - dbcount} out of the {usrcount} requested "
-                f"specids have no records available in the SPARCL database "
+                f"uuids have no records available in the SPARCL database "
                 f"associated with DataSets {dr_list}."
             )
             print(warn)

sparcl/gather_2d.py

@@ -39,9 +39,7 @@ def _wavelength_offsets(records):
         set(records[0].wavelength).union(*[r.wavelength for r in records[1:]])
     )
     # offsets[ri] = index into WINDOW
-    offsets = {
-        ri: window.index(rec.wavelength[0]) for ri, rec in enumerate(records)
-    }
+    offsets = {ri: window.index(rec.wavelength[0]) for ri, rec in enumerate(records)}  # noqa: E501
     return (window, offsets)
 
 
@@ -89,7 +87,7 @@ def _align_wavelengths(records):
 
 
 def _tt1(numrecs=20, dr="BOSS-DR16"):
-    client = sparcl.client.SparclClient()
+    client = sparcl.client.SparclClient(announcement=False)
     found = client.find(constraints=dict(data_release=[dr]), limit=numrecs)
     got = client.retrieve(found.ids)
     records = got.records
@@ -188,7 +186,7 @@ def align_records(records, fields=["flux", "wavelength"], precision=7):
         - grid(ndarray): 1D numpy array containing wavelength values.
 
     Example:
-        >>> client = sparcl.client.SparclClient()
+        >>> client = sparcl.client.SparclClient(announcement=False)
         >>> specflds = ['wavelength', 'model']
         >>> cons = {"data_release": ['BOSS-DR16']}
         >>> found = client.find(constraints=cons, limit=21)

sparcl/resample_spectra.py

@@ -32,10 +32,9 @@ def _resample_flux(records, wavstep=1):
 
 
 def _tt0(numrecs=20):
-    client = sparcl.client.SparclClient()
-    found = client.find(
-        constraints=dict(data_release=["BOSS-DR16"]), limit=numrecs
-    )
+    client = sparcl.client.SparclClient(announcement=False)
+    found = client.find(constraints=dict(data_release=["BOSS-DR16"]),
+                        limit=numrecs)
     got = client.retrieve(found.ids)
     flux_2d, new_wavs = _resample_flux(got.records)
     return flux_2d, new_wavs

{sparclclient-1.2.6b13.dist-info → sparclclient-1.2.7b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sparclclient
-Version: 1.2.6b13
+Version: 1.2.7b1
 Summary: A client for getting spectra and meta-data from NOIRLab.
 Author-email: "S. Pothier" <datalab-spectro@noirlab.edu>
 Description-Content-Type: text/markdown

{sparclclient-1.2.6b13.dist-info → sparclclient-1.2.7b1.dist-info}/RECORD

@@ -1,11 +1,11 @@
 sparcl/Results.py,sha256=vnACjm8sp7MrsJ_5LTuKMuyRWqeBJxOxQM302cHmAlk,9159
-sparcl/__init__.py,sha256=nzI5cO-Rr3chwX0dScwd-8pzeEigrpiyu-Vh_psbFic,1125
-sparcl/client.py,sha256=a3uUD19yi_hHAkRtpk-A2gXQ_w1l1LktDFLCrUUAcV0,39876
+sparcl/__init__.py,sha256=Q1yzegsPH1nPWbN9a9AlmYJQMgZtmf-Ymt-FZ5uh1I0,1147
+sparcl/client.py,sha256=Kv4wPUNIwAsRkzA0CMgCndKByKf9uyWaXfIyyC4RTqA,40015
 sparcl/conf.py,sha256=GFNDelaiVIAkjNjvFlG7HAlPpU39nqZmTPohQGmOcgI,928
 sparcl/exceptions.py,sha256=sznmOMGENHvxutSXlRVWqi87bR2Qiebka7LyR3mAII0,4244
 sparcl/fields.py,sha256=NZUBqDidpbXfeX5F4b306F323xZY2CRIx8eVv-HWTVU,5127
-sparcl/gather_2d.py,sha256=r_ZXinXlr3bOOwHrNBSWvtKC4-Dohv4nYA3iEiT1_G8,8686
-sparcl/resample_spectra.py,sha256=Z_Lkoq4LapaIQp7tqZ88LayRLE8o9c832Icc0jSr5ok,1282
+sparcl/gather_2d.py,sha256=YTFVQl38dRZjUu0AEUFVZtQm7zC8mU3LVvUTDGxp6u8,8722
+sparcl/resample_spectra.py,sha256=nk5HiyaGF-b9SiTmIC9yJBbYX4VYsiLFHyW186bPs2s,1310
 sparcl/sparc.ini,sha256=q_wjo9DLnCYRxWFMl0CtMYp4DD1AXfEcK6BP6cmncwo,329
 sparcl/type_conversion.py,sha256=QmXNX9j_7QHnBu83f2ZBfREoql9wuo98ZbhQtSjRRWc,12965
 sparcl/unsupported.py,sha256=bfkkZa-PuqwN-Bqo3vCIrLupbWMDTCiTHPMNfXnqmMc,1848
@@ -15,7 +15,7 @@ sparcl/benchmarks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU
 sparcl/benchmarks/benchmarks.py,sha256=OmlSdnAPLmcvGXsr-HzGyfAAcnoqlO0JQ4EIA7JGhZc,9424
 sparcl/benchmarks/sparcl_benchmarking.ipynb,sha256=gwof2hqM9Qb49qzRX-mky7WNqXZCMSB7ry8bX8dImxc,17559
 sparcl/notebooks/sparcl-examples.ipynb,sha256=gEwMKI1x7A1YsVeCsQn1QoMO0ZuIhMUAu3qedTiQ7hM,169268
-sparclclient-1.2.6b13.dist-info/LICENSE,sha256=y10EluGMCzGs9X4oYCYyix3l6u-lawB_vlGR8qe442Q,1576
-sparclclient-1.2.6b13.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
-sparclclient-1.2.6b13.dist-info/METADATA,sha256=IGZU4IteE-oPqmbyRJMlWC4Gx9QzHKQK4MeeYDlG8hA,681
-sparclclient-1.2.6b13.dist-info/RECORD,,
+sparclclient-1.2.7b1.dist-info/LICENSE,sha256=y10EluGMCzGs9X4oYCYyix3l6u-lawB_vlGR8qe442Q,1576
+sparclclient-1.2.7b1.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
+sparclclient-1.2.7b1.dist-info/METADATA,sha256=PGbwbr4YpUV0GyMIG79I7kkFUtiniEHNo_tx1gt5OvA,680
+sparclclient-1.2.7b1.dist-info/RECORD,,