Skip to content

Commit d979134

Browse files
Jorge Fernandez HernandezJorge Fernandez Hernandez
authored andcommitted
EUCLIDPCR-1863 check grammar
1 parent 864856e commit d979134

File tree

1 file changed

+43
-45
lines changed

1 file changed

+43
-45
lines changed

docs/esa/euclid/euclid.rst

Lines changed: 43 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ out to redshifts ~2, or equivalently to a look-back time of 10 billion years. It
1212
expanded and how structure has formed over cosmic history, revealing more about the role of gravity and the nature of
1313
dark energy and dark matter.
1414

15-
This package allows the access to the European Space Agency Euclid Archive (https://eas.esac.esa.int/).
15+
This package allows access to the European Space Agency Euclid Archive (https://eas.esac.esa.int/).
1616

1717
The Euclid Survey is done in a 'step-and-stare' mode, where the telescope points to a position on the sky and then
1818
imaging and spectroscopic measurements are performed on an area of ~0.48 deg\ :sup:`2` around this position. The telescope
@@ -23,7 +23,7 @@ For the survey standard operating mode, the telescope undertakes a 4-point dithe
2323
each take a 560s exposure, consisting of a direct visible image and a red grism exposure. This is followed by further
2424
NISP exposures in the Y, J, and H band filters (87 seconds each). The telescope is then dithered, and the sequence is
2525
repeated starting with a different grism position angle. There are actually two operational grisms oriented 180 degrees
26-
from each other. Each grism which will be used twice in this sequence, but with slight angular offsets (+/- 4 degrees),
26+
from each other. Each grism will be used twice in this sequence, but with slight angular offsets (+/- 4 degrees),
2727
effectively creating the four different grism angles (Scaramella et al. 2022, A&A 662, A112).
2828

2929
This standard four-dithers operating mode sequence is called a single observation and all the individual exposures
@@ -44,21 +44,21 @@ widely used to query databases.
4444
TAP provides two operation modes: Synchronous and Asynchronous:
4545

4646
* Synchronous: the response to the request will be generated as soon as the request received by the server.
47-
(Do not use this method for queries that generate a big amount of results.)
47+
(Do not use this method for queries that generate a large amount of results.)
4848
* Asynchronous: the server starts a job that will execute the request.
4949
The first response to the request is the required information (a link) to obtain the job status.
5050
Once the job is finished, the results can be retrieved.
5151

5252

53-
ESA EUCLID TAP+ server provides two access mode: public and authenticated:
53+
ESA EUCLID TAP+ server provides two access modes: public and authenticated:
5454

5555
* Public: this is the standard TAP access.
5656
A user can execute ADQL queries and upload tables to be used in a query 'on-the-fly' (these tables will be removed
57-
once the query is executed). The results are available to any other user and they will remain in the server for a
57+
once the query is executed). The results are available to any other user, and they will remain in the server for a
5858
limited space of time.
5959

6060
* Authenticated: some functionalities are restricted to authenticated users only.
61-
The results are saved in a private user space and they will remain in the server for ever (they can be removed by the
61+
The results are saved in a private user space and they will remain in the server forever (they can be removed by the
6262
user).
6363

6464
* ADQL queries and results are saved in a user private area.
@@ -97,13 +97,13 @@ This method will retrieve the same warning messages shown in EUCLID Science Arch
9797

9898
The Euclid Science Archive has several environments serving different purposes for the Euclid Consortium members.
9999

100-
1. The OTF ("on-the-fly") environment of the Euclid science archive, first started at the start of science operation exposed data as processed as processed by
100+
1. The OTF ("on-the-fly") environment of the Euclid science archive, first started at the start of science operation exposed data as processed by
101101
the SGS (Science Ground Segment) soon after acquisition to provide an access as soon as possible. In this environment
102102
the data will not be reprocessed and the processing is therefore heterogeneous.
103103

104104
2. The REG (for non-regression testing) environment of the Euclid science archive, where a large area in the sky is processed with the same version for
105105
all data products. The first campaign was run in September 2024, for area of about 500 square degrees (~1000
106-
observation), the next campaign shall be run in March-April 2025.
106+
observations), the next campaign shall be run in March-April 2025.
107107

108108
3. The IDR (Internal Data Release) environment of the Euclid science archive holds the data that will then become public. The first release Q1
109109
opened on the 6th of November 2024, with a first pass on the three Euclid deep fields (EDFN, EDFS and EDFF) as well as
@@ -136,8 +136,7 @@ makes use of the *PDR* environment. In order to make use of a different one, it
136136
>>> from astroquery.esa.euclid import EuclidClass
137137
>>> euclid = EuclidClass(environment='IDR')
138138

139-
The parameter *environment* can take only the following values: *IDR*, *OTF*, *PDR* or *REG*.
140-
139+
The parameter *environment* is limited to *IDR*, *OTF*, *PDR* or *REG*.
141140

142141

143142
1. Non authenticated access
@@ -146,7 +145,7 @@ The parameter *environment* can take only the following values: *IDR*, *OTF*, *P
146145
1.1. Getting public tables metadata
147146
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
148147

149-
Table and columns metadata are specified by IVOA TAP_ recommendation (to access to the actual data, an ADQL query must be executed).
148+
Table and column metadata are specified by IVOA TAP_ recommendation (to access to the actual data, an ADQL query must be executed).
150149

151150
To load only table names metadata (TAP+ capability):
152151

@@ -179,8 +178,7 @@ To load only table names metadata (TAP+ capability):
179178
...
180179

181180

182-
183-
To load all tables metadata (TAP compatible):
181+
To load all table metadata (TAP compatible):
184182

185183
.. doctest-remote-data::
186184

@@ -300,7 +298,7 @@ This query searches for all the objects contained in an arbitrary rectangular pr
300298
WARNING: This method implements the ADQL BOX function that is deprecated in the latest version of the standard
301299
(ADQL 2.1, see: https://ivoa.net/documents/ADQL/20231107/PR-ADQL-2.1-20231107.html#tth_sEc4.2.9).
302300

303-
The following example searches for all the sources contained in an squared region of side = 0.1 degrees around an specific point in ra/dec coordinates. The results are sorted by distance (``dist``) in ascending order.
301+
The following example searches for all the sources contained in an squared region of side = 0.1 degrees around a specific point in ra/dec coordinates. The results are sorted by distance (``dist``) in ascending order.
304302

305303
The method returns the job results as astropy.table
306304

@@ -371,9 +369,9 @@ The previous query can be executed as an asynchronous version:
371369
^^^^^^^^^^^^^^^^^^^^^^
372370

373371
The results of a synchronous query are stored at the user side (i.e., they are not saved in the server). These queries
374-
can only used when the amount of data to be retrieved (number of rows) is small, otherwise, a timeout error can be raised.
372+
can only be used when the amount of data to be retrieved (number of rows) is small, otherwise, a timeout error can be raised.
375373
The output of the synchronous queries is limited to 2000 rows. If you need more than that, you must use asynchronous queries.
376-
The results of asynchronous queries can be saved in memory (default) or in a file but is also stored on the server/archive
374+
The results of asynchronous queries can be saved in memory (default) or in a file but are also stored on the server/archive
377375
so you can access the results by logging in on the archive website too.
378376

379377
Query without saving results in a file:
@@ -411,7 +409,7 @@ Query without saving results in a file:
411409

412410
The method returns a Job object.
413411

414-
Query saving results in a file (you may use 'output_format' to specified the results data format, available formats are:
412+
Query saving results in a file (you may use 'output_format' to specify the results' data format. Available formats are:
415413
'votable', 'votable_plain', 'fits', 'csv' and 'json', default is 'votable'):
416414

417415
.. Skipping authentication requiring examples
@@ -440,7 +438,7 @@ Query saving results in a file (you may use 'output_format' to specified the res
440438
59.5694307527783 -47.00910465608437 162 0.030248118564486504 0.0021698300261050463 11.478931427001953
441439

442440

443-
Note: you can inspect the status of the job by typing:
441+
You can inspect the status of the job by typing:
444442

445443
.. Skipping authentication requiring examples
446444
.. doctest-skip::
@@ -471,11 +469,11 @@ Note: to obtain the current location, type:
471469
1.5. Asynchronous query
472470
^^^^^^^^^^^^^^^^^^^^^^^
473471

474-
Asynchronous queries save all results at server side which means they take up the user's file quota on the archive.
472+
Asynchronous queries save all results on the server side, which means they take up the users file quota in the archive.
475473
These queries can be accessed at any time on the archive website. For anonymous users, results are kept for three days.
476-
For authenticated users the asynchronous results are kept at server side forever (until the user decides to remove them).
477-
Make sure to delete the results you don't need anymore every once in a while to make sure you don't reach the archive
478-
user quota. When that happens all future jobs/queries will start failing. You can delete the jobs on the archive website
474+
For authenticated users, the asynchronous results are kept at the server side forever (until the user decides to remove them).
475+
Make sure to delete the results you dont need anymore every once in a while to make sure you dont reach the archive user
476+
quota. When that happens, all future jobs/queries will start failing. You can delete the jobs on the archive website
479477
(and soon through python too).
480478

481479
The results of the execution of the queries can be stored locally in memory (by default) or in a file. The following
@@ -528,7 +526,7 @@ To get all the asynchronous jobs:
528526
Results: None
529527

530528

531-
To remove asynchronous
529+
To remove asynchronous jobs:
532530

533531
.. Pseudo code with ``job_id`` list ellipsis, skipping test
534532
.. doctest-skip::
@@ -576,25 +574,25 @@ Note: to obtain the current location, type:
576574

577575
Authenticated users are able to access to TAP+ capabilities (shared tables, persistent jobs, etc.) In order to
578576
authenticate a user, ``login`` method must be called. After a successful authentication, the user will be authenticated
579-
until ``logout`` method is called.
577+
until the ``logout`` method is called.
580578

581579
All previous methods (``query_object``, ``cone_search``, ``load_table``, ``load_tables``, ``launch_job``) explained for
582580
non authenticated users are applicable for authenticated ones.
583581

584582
The main differences are:
585583

586-
* Asynchronous results are kept at server side for ever (until the user decides to remove one of them).
587-
* Users can access to shared tables.
584+
* Asynchronous results are kept at the server side forever (until the user decides to remove one of them).
585+
* Users can access to share tables.
588586

589587

590588
2.1. Login/Logout
591589
^^^^^^^^^^^^^^^^^
592590

593-
There are several ways to login to Euclid archive.
591+
There are several ways to log in to the Euclid archive.
594592

595593
**Login through graphic interface**
596594

597-
*Note: Python Tkinter module is required to use login_gui method.*
595+
*Note: The Python Tkinter module is required to use the login_gui method.*
598596

599597
.. Skipping authentication requiring examples
600598
.. doctest-skip::
@@ -624,7 +622,7 @@ or
624622

625623
It is possible to use a file where the credentials are stored:
626624

627-
*The file must containing user and password in two different lines.*
625+
*The file must contain user and password in two different lines.*
628626

629627
.. Skipping authentication requiring examples
630628
.. doctest-skip::
@@ -719,7 +717,7 @@ It is possible to download a product given its file name or product id:
719717
:alt: EUC_MER_BGSUB-MOSAIC-NIR-H_TILE102158889-ED035A_20241024T212936.705156Z_00.00.fits
720718

721719

722-
The method downloads the fits file(s) and returns the local path where the product(s) are saved.
720+
The method downloads the fits file(s) and returns the local path where the product(s) is saved.
723721

724722
To download the products for a given EUCLID observation_id (observations) or tile_index (mosaics):
725723

@@ -775,7 +773,7 @@ To download a cutout given its file path, instrument and obs_id, and the cutout
775773
:alt: astroquery_cutout_example.fits
776774

777775

778-
Below is the equivalent version but copying arguments manually (for clarity)
776+
Below is the equivalent version but copying arguments manually (for clarity).
779777

780778
.. Skipping authentication requiring examples
781779
.. doctest-skip::
@@ -807,7 +805,7 @@ To obtain a list of the tables shared to a user type the following:
807805
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
808806

809807
It is now possible to store a table in the private user space. The table to be uploaded can
810-
be in a VOTable_ located in a given URL, a table stored in a local file in the user machine,
808+
be in a VOTable_ located at a given URL, a table stored in a local file in the user machine,
811809
a pre-computed Astropy table file or a job executed in the Euclid archive.
812810

813811
.. _VOTable: https://www.ivoa.net/documents/VOTable/
@@ -822,7 +820,7 @@ referenced as 'user_joe.table_name'
822820
An already generated VOTable, accessible through a URL, can be uploaded to Euclid archive.
823821

824822
The following example launches a query to Vizier TAP ('url' parameter). The result is a
825-
VOTable that can be uploaded to the user private area.
823+
VOTable that can be uploaded to the user's private area.
826824

827825
Your schema name will be automatically added to the provided table name:
828826

@@ -856,7 +854,7 @@ surrounded by quotation marks, i.e.: *user_<your_login_name>."<table_name>"*):
856854
2.5.2. Uploading table from file
857855
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
858856

859-
A file containing a table (votable, fits or csv) can be uploaded to the user private area.
857+
A file containing a table (votable, fits or csv) can be uploaded to the user's private area.
860858

861859
The parameter 'format' must be provided when the input file is not a votable file.
862860

@@ -921,7 +919,7 @@ surrounded by quotation marks, i.e.: *user_<your_login_name>."<table_name>"*):
921919
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
922920

923921
The results generated by an *asynchronous* job (from a query executed in the Euclid archive) can be
924-
ingested in a table in the user private area.
922+
ingested in a table in the user's private area.
925923

926924
The following example generates a job in the Euclid archive and then, the results are ingested in a
927925
table named: user_<your_login_name>.'t'<job_id>:
@@ -952,7 +950,7 @@ surrounded by quotation marks since it contains capital letters.):
952950
2.6. Deleting table
953951
^^^^^^^^^^^^^^^^^^^
954952

955-
A table from the user private area can be deleted as follows:
953+
A table from the user's private area can be deleted as follows:
956954

957955
.. Skipping authentication requiring examples
958956
.. doctest-skip::
@@ -967,7 +965,7 @@ A table from the user private area can be deleted as follows:
967965

968966
It can be useful for the user to modify the metadata of a given table. For example, a user
969967
might want to change the description (UCD) of a column, or the flags that give extra information
970-
about certain column. This is possible using:
968+
about a certain column. This is possible using:
971969

972970
.. Skipping authentication requiring examples
973971
.. doctest-skip::
@@ -1025,7 +1023,7 @@ We can type the following:
10251023
^^^^^^^^^^^^^^^^
10261024

10271025
It is possible to run a geometric cross-match between the ra/dec coordinates of two tables
1028-
using the crossmatch function provided by the archive. In order to do so the user must be
1026+
using the crossmatch function provided by the archive. In order to do so, the user must be
10291027
logged in. This is required because the cross match operation will generate a join table
10301028
in the user private area. That table contains the identifiers of both tables and the separation,
10311029
in degrees, between ra/dec coordinates of each source in the first table and its associated
@@ -1072,7 +1070,7 @@ Cross-matching catalogues is one of the most popular operations executed in the
10721070

10731071
It is possible to share tables with other users. You have to create a group, populate that
10741072
group with users, and share your table to that group. Then, any user belonging to that group
1075-
will be able to access to your shared table in a query.
1073+
will be able to access your shared table in a query.
10761074

10771075
2.9.1. Creating a group
10781076
^^^^^^^^^^^^^^^^^^^^^^^
@@ -1156,12 +1154,12 @@ will be able to access to your shared table in a query.
11561154
DataLink_ is a data access protocol compliant with the IVOA_ architecture that provides a linking mechanism between
11571155
datasets offered by different services. In practice, it can be seen and used as a web service providing the list of additional
11581156
data products available for each object outside the main catalogue(s). For more information about the products served via
1159-
DataLink in the Euclid ESA Archive we recommend to read the Archive DataLink tutorials available at https://eas.esac.esa.int/sas/.
1157+
DataLink in the Euclid ESA Archive we recommend reading the Archive DataLink tutorials available at https://eas.esac.esa.int/sas/.
11601158

1161-
The DataLink products is restricted to authenticated users. via the `~astroquery.utils.tap.TapPlus.load_data` method.
1159+
The DataLink products are restricted to authenticated users via the `~astroquery.utils.tap.TapPlus.load_data` method.
11621160
From SAS the Datalink service can be used to access and download 1D Spectra data.
11631161

1164-
To find out the resources associated to a given source:
1162+
To find out the resources associated with a given source:
11651163

11661164
.. Skipping authentication requiring examples
11671165
.. doctest-skip::
@@ -1171,7 +1169,7 @@ To find out the resources associated to a given source:
11711169
>>> datalink = Euclid.get_datalinks(ids=ids)
11721170

11731171

1174-
The query below retrieves a random a sample of Euclid sources having spectra, i.e., ancillary products.
1172+
The query below retrieves a random sample of Euclid sources having spectra, i.e., ancillary products.
11751173

11761174
.. Skipping authentication requiring examples
11771175
.. doctest-skip::
@@ -1210,7 +1208,7 @@ The query below retrieves a random a sample of Euclid sources having spectra, i.
12101208
Length = 2000 rows
12111209

12121210

1213-
The following example shows how to retrieve the DataLink products (1D Spectra) associated to the previous sources (IDs).
1211+
The following example shows how to retrieve the DataLink products (1D Spectra) associated with the previous sources (IDs).
12141212

12151213
.. Skipping authentication requiring examples
12161214
.. doctest-skip::
@@ -1234,7 +1232,7 @@ The DataLink products are stored inside a Python Dictionary. Each of its element
12341232

12351233
.. Note::
12361234

1237-
It is not possible to search for and retrieve the DataLink products associated to more than 5000 sources in one and the same call.
1235+
It is not possible to search for and retrieve the DataLink products associated with more than 5000 sources in one and the same call.
12381236
However, it is possible to overcome this limit programmatically using a sequential download.
12391237

12401238
.. _DataLink: https://www.ivoa.net/documents/DataLink/

0 commit comments

Comments
 (0)