Merge pull request #3409 from esdc-esac-esa-int/ESA_gaia_C9GACS-1060_new_retrieval_type_McmcSamplesGspPhot

Author: bsipocz

astroquery/gaia/__init__.py

@@ -31,10 +31,9 @@ class Conf(_config.ConfigNamespace):
                                       'RVS',
                                       'MEAN_SPECTRUM_RVS',
                                       'MCMC_GSPPHOT',
+                                      'MCMC_GSP_PHOT',
                                       'MCMC_MSC',
                                       'EPOCH_ASTROMETRY',
-                                      'RVS_EPOCH_DATA_SINGLE',
-                                      'RVS_EPOCH_DATA_DOUBLE',
                                       'EPOCH_SPECTRUM_RVS',
                                       'EPOCH_ASTROMETRY_CROWDED_FIELD',
                                       'EPOCH_PHOTOMETRY_CROWDED_FIELD',

astroquery/gaia/core.py

@@ -13,8 +13,6 @@
 import os
 import shutil
 import zipfile
-from collections.abc import Iterable
-
 from astropy import units
 from astropy import units as u
 from astropy.coordinates import Angle
@@ -23,6 +21,7 @@
 from astropy.table import Table
 from astropy.units import Quantity
 from astropy.utils.decorators import deprecated_renamed_argument
+from collections.abc import Iterable
 from requests import HTTPError
 
 from astroquery import log
@@ -174,54 +173,52 @@ def load_data(self, ids, *, data_release=None, data_structure='INDIVIDUAL', retr
         Parameters
         ----------
         ids :  str, int, str list or int list, mandatory
-            list of identifiers
+            List of identifiers
         data_release: str, optional, default None
-            data release from which data should be taken. E.g. 'Gaia DR3'
-            By default, it takes the current default one.
+            Data release from which data should be taken. E.g. 'Gaia DR3'. By default, it takes the current default one.
         data_structure: str, optional, default 'INDIVIDUAL'
-            it can be 'INDIVIDUAL' or 'RAW':
+            It can be 'INDIVIDUAL' or 'RAW':
             'INDIVIDUAL' means products are provided in separate files for each sourceId. All files are zipped
-            in a single bundle, even if only one source/file is considered
-            'RAW' means products are provided following a Data Model similar to that used in the MDB, meaning in
-            particular that parameters stored as arrays will remain as such. A single file is provided for the data of
-            all sourceIds together, but in this case there will be always be one row per sourceId.
-        retrieval_type : str, optional, default 'ALL' to retrieve all data  from the list of sources
-            retrieval type identifier. For GAIA DR2 possible values are ['EPOCH_PHOTOMETRY']
-            For GAIA DR3, possible values are ['EPOCH_PHOTOMETRY', 'RVS', 'XP_CONTINUOUS', 'XP_SAMPLED',
-            'MCMC_GSPPHOT' or 'MCMC_MSC']
-            For GAIA DR4, possible values will be ['EPOCH_PHOTOMETRY', 'MEAN_SPECTRUM_RVS', 'XP_CONTINUOUS',
-            'XP_SAMPLED', 'MCMC_GSPPHOT', 'MCMC_MSC', 'EPOCH_ASTROMETRY', 'RVS_EPOCH_DATA_SINGLE',
-            'RVS_EPOCH_DATA_DOUBLE','EPOCH_SPECTRUM_RVS', 'EPOCH_ASTROMETRY_CROWDED_FIELD',
+            in a single bundle, even if only one source/file is considered 'RAW' means products are provided
+            following a Data Model similar to that used in the MDB, meaning in particular that parameters stored as
+            arrays will remain as such. A single file is provided for the data of all sourceIds together, but in this
+            case there will be always be one row per sourceId.
+        retrieval_type : str, optional, default ‘ALL’ to retrieve all data from the list of sources
+            Retrieval type identifier:
+            For Gaia DR2, the only possible values is ['EPOCH_PHOTOMETRY']
+            For Gaia DR3, the possible values are ['EPOCH_PHOTOMETRY', 'RVS', 'XP_CONTINUOUS', 'XP_SAMPLED',
+            'MCMC_GSPPHOT', 'MCMC_MSC']
+            For Gaia DR4, the possible values will be ['EPOCH_PHOTOMETRY', 'MEAN_SPECTRUM_RVS', 'MCMC_GSP_PHOT',
+            'EPOCH_ASTROMETRY', 'EPOCH_SPECTRUM_RVS', 'EPOCH_ASTROMETRY_CROWDED_FIELD',
             'EPOCH_PHOTOMETRY_CROWDED_FIELD', 'EPOCH_IMAGE', 'EPOCH_PHOTOMETRY_CCD', 'EPOCH_SPECTRUM_XP_SSO',
             'EPOCH_SPECTRUM_XP_CROWDING', 'MEAN_SPECTRUM_XP', 'EPOCH_SPECTRUM_XP', 'CROWDED_FIELD_IMAGE',
             'EPOCH_ASTROMETRY_BRIGHT', 'MEAN_SPECTRUM_XP_GRAVLENS', 'EPOCH_FLAGS_NSS', 'EPOCH_PARAMETERS_RVS_SINGLE',
-            'EPOCH_PARAMETERS_RVS_DOUBLE', 'EPOCH_FLAGS_VARI']. Note that for 'CROWDED_FIELD_IMAGE' only the format
-            'fits' can be used, and that its image, in the principal header, will not be available in the returned
+            'EPOCH_PARAMETERS_RVS_DOUBLE', 'EPOCH_FLAGS_VARI']. Note that for 'CROWDED_FIELD_IMAGE', only the format
+            'fits' can be used, and its image, in the principal header, will not be available in the returned
             dictionary. Set 'output_file' to retrieve all data: image + tables.
         linking_parameter : str, optional, default SOURCE_ID, valid values: SOURCE_ID, TRANSIT_ID, IMAGE_ID
             By default, all the identifiers are considered as source_id
             SOURCE_ID: the identifiers are considered as source_id
             TRANSIT_ID: the identifiers are considered as transit_id
             IMAGE_ID: the identifiers are considered as sif_observation_id
         valid_data : bool, optional, default False
-            By default, the epoch photometry service returns all available data, including
-            data rows where flux is null and/or the rejected_by_photometry flag is set to True.
-            In order to retrieve only valid data (data rows where flux is not null and/or the
-            rejected_by_photometry flag is set to False) this request parameter should be included
-            with valid_data=True.
+            By default, the epoch photometry service returns all available data, including data rows where flux is
+            null and/or the rejected_by_photometry flag is set to True. In order to retrieve only valid data (data
+            rows where flux is not null and/or the rejected_by_photometry flag is set to False) this request
+            parameter should be included with valid_data=True.
         avoid_datatype_check: boolean, optional, default False.
-            By default, this value will be set to False. If it is set to 'true'
-            the Datalink items tags will not be checked.
+            By default, this value will be set to False. If it is set to 'true' the Datalink items tags will not be
+            checked.
         format : str, optional, default 'votable'
-            loading format. Other available formats are 'csv', 'ecsv','votable_plain', 'json' and 'fits'
+            Loading format. Other available formats are 'csv', 'ecsv','votable_plain', 'json' and 'fits'
         dump_to_file: boolean, optional, default False.
             If it is true, a compressed directory named "datalink_output_<time_stamp>.zip" with all the DataLink
             files is made in the current working directory. The <time_stamp> format follows the ISO 8601 standard:
             "YYYYMMDD_HHMMSS.mmmmmm".
         overwrite_output_file : boolean, optional, default False
             To overwrite the output file ("datalink_output.zip") if it already exists.
         verbose : bool, optional, default 'False'
-            flag to display information about the process
+            Flag to display information about the process
 
         Returns
         -------