EUCLIDMNGT-1275 final changes from the archive scientists

Author: Jorge Fernandez Hernandez

astroquery/esa/euclid/core.py

@@ -1277,8 +1277,8 @@ def get_datalinks(self, ids, *, linking_parameter='SOURCE_ID', verbose=False):
 
         return self.__eucliddata.get_datalinks(ids=ids, linking_parameter=linking_parameter, verbose=verbose)
 
-    def get_scientific_data_product_list(self, *, observation_id=None, tile_index=None, category=None, group=None,
-                                         product_type=None, dataset_release='LEVEL_3_RELEASE', verbose=False):
+    def get_scientific_product_list(self, *, observation_id=None, tile_index=None, category=None, group=None,
+                                    product_type=None, dataset_release='REGREPROC1_R2', verbose=False):
         """ Gets the LE3 products (the high-level science data products).
 
         Please note that not all combinations of category, group, and product_type are valid.
@@ -1308,6 +1308,7 @@ def get_scientific_data_product_list(self, *, observation_id=None, tile_index=No
                     #. 'SEL Config/Stats'
                 #. External Data Products
                     #. 'LE3-ED configuration catalog'
+                    #. 'LE3-ED match catalog'
                 #. Weak Lensing Products
                     #. '2PCF'
                     #. 'PK'
@@ -1346,6 +1347,7 @@ def get_scientific_data_product_list(self, *, observation_id=None, tile_index=No
                 #. External Data Products
                     #. LE3-ED configuration catalog
                         #. 'DpdLE3edConfigurationFile': LE3-ED configuration catalog
+                    #. LE3-ED match catalog #
                         #. 'DpdLE3edMatchedCatalog': LE3-ED match catalog
                 #. Weak Lensing Products
                     #. 2PCF
@@ -1442,8 +1444,8 @@ def get_scientific_data_product_list(self, *, observation_id=None, tile_index=No
                         #. 'DpdLE3gcTwoPointRecCrossCorrPol': 2D Polar [Post-reconstruction 2D Polar and Multipole
                         Cross-correlation Product]
                     #. 3PCF_BK
-                        #. 'DpdLE3gcThreePointAll': 3PCF Triplets “ALL” Product
-                        #. 'DpdLE3gcThreePointSin': 3PCF Correlation “SINGLE” Product
+                        #. 'DpdLE3gcThreePointAll': 3PCF Triplets "ALL" Product
+                        #. 'DpdLE3gcThreePointSin': 3PCF Correlation "SINGLE" Product
                         #. 'DpdLE3gcBkMonopole': Bispectrum Product Monopole
                         #. 'DpdLE3gcBkMultipole': Bispectrum Product Multipoles
                     #. CM-2PCF
@@ -1544,14 +1546,14 @@ def get_scientific_data_product_list(self, *, observation_id=None, tile_index=No
                         #. 'DpdReferenceSample':
                         #. 'DpdTomographicBins':
 
-        dataset_release : str, mandatory. Default LEVEL_3_RELEASE
+        dataset_release : str, mandatory. Default REGREPROC1_R2
             Data release from which data should be taken.
         verbose : bool, optional, default 'False'
             flag to display information about the process
 
         Returns
         -------
-        A table object
+        The list of products (astropy.table)
 
         """
 

astroquery/esa/euclid/tests/test_euclidtap.py

@@ -1060,42 +1060,42 @@ def test_get_scientific_data_product_list():
 
     euclid = EuclidClass(tap_plus_conn_handler=conn_handler, datalink_handler=tap_plus, show_server_messages=False)
 
-    results = euclid.get_scientific_data_product_list(observation_id=11111)
+    results = euclid.get_scientific_product_list(observation_id=11111)
 
     assert results is not None, "Expected a valid table"
 
-    results = euclid.get_scientific_data_product_list(tile_index=11111)
+    results = euclid.get_scientific_product_list(tile_index=11111)
 
     assert results is not None, "Expected a valid table"
 
-    results = euclid.get_scientific_data_product_list(category='Clusters of Galaxies', group='GrpCatalog',
-                                                      product_type='DpdLE3clAmicoAux')
+    results = euclid.get_scientific_product_list(category='Clusters of Galaxies', group='GrpCatalog',
+                                                 product_type='DpdLE3clAmicoAux')
 
     assert results is not None, "Expected a valid table"
 
-    results = euclid.get_scientific_data_product_list(category='Weak Lensing Products', group='2PCF',
-                                                      product_type='DpdCovarTwoPCFWLClPosPos2D')
+    results = euclid.get_scientific_product_list(category='Weak Lensing Products', group='2PCF',
+                                                 product_type='DpdCovarTwoPCFWLClPosPos2D')
 
     assert results is not None, "Expected a valid table"
 
-    results = euclid.get_scientific_data_product_list(category='Weak Lensing Products')
+    results = euclid.get_scientific_product_list(category='Weak Lensing Products')
 
     assert results is not None, "Expected a valid table"
 
-    results = euclid.get_scientific_data_product_list(category='Weak Lensing Products', group='2PCF')
+    results = euclid.get_scientific_product_list(category='Weak Lensing Products', group='2PCF')
 
     assert results is not None, "Expected a valid table"
 
-    results = euclid.get_scientific_data_product_list(group='2PCF', product_type='DpdCovarTwoPCFWLClPosPos2D')
+    results = euclid.get_scientific_product_list(group='2PCF', product_type='DpdCovarTwoPCFWLClPosPos2D')
 
     assert results is not None, "Expected a valid table"
 
-    results = euclid.get_scientific_data_product_list(category='Weak Lensing Products',
-                                                      product_type='DpdCovarTwoPCFWLClPosPos2D')
+    results = euclid.get_scientific_product_list(category='Weak Lensing Products',
+                                                 product_type='DpdCovarTwoPCFWLClPosPos2D')
 
     assert results is not None, "Expected a valid table"
 
-    results = euclid.get_scientific_data_product_list(product_type='DpdCovarTwoPCFWLClPosPos2D')
+    results = euclid.get_scientific_product_list(product_type='DpdCovarTwoPCFWLClPosPos2D')
 
     assert results is not None, "Expected a valid table"
 
@@ -1104,43 +1104,43 @@ def test_get_scientific_data_product_list_exceptions():
     eculid = EuclidClass()
 
     with pytest.raises(ValueError, match="Include a valid parameter to retrieve a LE3 product."):
-        eculid.get_scientific_data_product_list(observation_id=None, tile_index=None, category=None, group=None,
-                                                product_type=None)
+        eculid.get_scientific_product_list(observation_id=None, tile_index=None, category=None, group=None,
+                                           product_type=None)
 
     with pytest.raises(ValueError, match="The release is required."):
-        eculid.get_scientific_data_product_list(observation_id=11111, dataset_release=None)
+        eculid.get_scientific_product_list(observation_id=11111, dataset_release=None)
 
     with pytest.raises(ValueError, match="Incompatible: 'observation_id' and 'tile_id'. Use only one."):
-        eculid.get_scientific_data_product_list(observation_id=11111, tile_index=1234567)
+        eculid.get_scientific_product_list(observation_id=11111, tile_index=1234567)
 
     with pytest.raises(ValueError, match=r"Invalid combination of parameters: category=not_valid. *."):
-        eculid.get_scientific_data_product_list(observation_id=11111, category='not_valid')
+        eculid.get_scientific_product_list(observation_id=11111, category='not_valid')
 
     with pytest.raises(ValueError, match=r"Invalid combination of parameters: group=not_valid.  *."):
-        eculid.get_scientific_data_product_list(observation_id=11111, group='not_valid')
+        eculid.get_scientific_product_list(observation_id=11111, group='not_valid')
 
     with pytest.raises(ValueError, match=r"Invalid combination of parameters: product_type=not_valid.  *."):
-        eculid.get_scientific_data_product_list(observation_id=11111, product_type='not_valid')
+        eculid.get_scientific_product_list(observation_id=11111, product_type='not_valid')
 
     with pytest.raises(ValueError, match=r"Invalid combination of parameters: category=Clusters of Galaxies.  *."):
-        eculid.get_scientific_data_product_list(observation_id=11111, category='Clusters of Galaxies',
-                                                group='not_valid')
+        eculid.get_scientific_product_list(observation_id=11111, category='Clusters of Galaxies',
+                                           group='not_valid')
 
     with pytest.raises(ValueError, match=r"Invalid combination of parameters: category=Clusters of Galaxies; "
                                          r"group=GrpCatalog; product_type=not_valid. *."):
-        eculid.get_scientific_data_product_list(observation_id=11111, category='Clusters of Galaxies',
-                                                group='GrpCatalog',
-                                                product_type='not_valid')
+        eculid.get_scientific_product_list(observation_id=11111, category='Clusters of Galaxies',
+                                           group='GrpCatalog',
+                                           product_type='not_valid')
 
     with pytest.raises(ValueError,
                        match=r"Invalid combination of parameters: category=Clusters of Galaxies; "
                              r"product_type=not_valid.  *."):
-        eculid.get_scientific_data_product_list(observation_id=11111, category='Clusters of Galaxies',
-                                                product_type='not_valid')
+        eculid.get_scientific_product_list(observation_id=11111, category='Clusters of Galaxies',
+                                           product_type='not_valid')
 
     with pytest.raises(ValueError,
                        match=r"Invalid combination of parameters: group=GrpCatalog; product_type=not_valid. *."):
-        eculid.get_scientific_data_product_list(observation_id=11111, group='GrpCatalog', product_type='not_valid')
+        eculid.get_scientific_product_list(observation_id=11111, group='GrpCatalog', product_type='not_valid')
 
 
 @patch.object(TapPlus, 'login')

docs/esa/euclid/euclid.rst

@@ -248,6 +248,12 @@ It is possible to retrieve LE3 data (scientific data) by observation_id or tile_
 .. doctest-skip::
 
   >>> from astroquery.esa.euclid import Euclid
+    >>> le3_product_list = Euclid.get_scientific_product_list(tile_index=102034414)
+    >>> print("Found", len(le3_product_list), "results")
+    Found 12 results
+    >>> print(le3_product_list)
+
+  In the following example, for the LE3 Weak-Lensing data, we retrieve all the Tomographic Cosmic Shear Correlation products (2PCF TwoPCFWLShearShear2D):
   >>> le3_product_list = Euclid.get_scientific_data_product_list(tile_index=102034414)
   >>> print("Found", len(le3_product_list), "results")
   Found 12 results
@@ -259,6 +265,10 @@ In the following example, for the LE3 Weak-Lensing data, we retrieve all the Tom
 .. doctest-skip::
 
   >>> from astroquery.esa.euclid import Euclid
+    >>> results = euclid.get_scientific_product_list(category='Weak Lensing Products', group='2PCF', product_type='DpdTwoPCFWLShearShear2D')
+    >>> print("Found", len(le3_product_list), "results")
+    Found 12 results
+    >>> print(le3_product_list)
   >>> results = euclid.get_scientific_data_product_list(category='Weak Lensing Products', group='2PCF', product_type='DpdTwoPCFWLShearShear2D')
   >>> print("Found", len(le3_product_list), "results")
   Found 12 results