Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Gaia: delete any reference to data_structure "Combined" in the function load_data and in the documentation [ci skip] #3012

Merged
merged 1 commit into from
May 27, 2024
Merged

Gaia: delete any reference to data_structure "Combined" in the function load_data and in the documentation [ci skip] #3012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions astroquery/gaia/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,15 +182,12 @@ def load_data(self, ids, *, data_release=None, data_structure='INDIVIDUAL', retr
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', 'COMBINED', '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
'COMBINED' means products are provided in a single file concatenating the data of all sourceIds together.
How this is organised depends on the chosen format
'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. Like in the COMBINED structure, 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
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',
Expand Down
2 changes: 1 addition & 1 deletion docs/gaia/gaia.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -859,7 +859,7 @@ The following example shows how to retrieve the DataLink products associated wit
.. doctest-remote-data::

>>> retrieval_type = 'ALL' # Options are: 'EPOCH_PHOTOMETRY', 'MCMC_GSPPHOT', 'MCMC_MSC', 'XP_SAMPLED', 'XP_CONTINUOUS', 'RVS', 'ALL'
>>> data_structure = 'COMBINED' # Options are: 'INDIVIDUAL', 'COMBINED', 'RAW'
>>> data_structure = 'INDIVIDUAL' # Options are: 'INDIVIDUAL' or 'RAW'
>>> data_release = 'Gaia DR3' # Options are: 'Gaia DR3' (default), 'Gaia DR2'
>>> datalink = Gaia.load_data(ids=[2263166706630078848, 2263178457660566784, 2268372099615724288],
... data_release=data_release, retrieval_type=retrieval_type, data_structure=data_structure)
Expand Down