Skip to content

Commit 2ebfc32

Browse files
Jorge Fernandez HernandezJorge Fernandez Hernandez
authored andcommitted
EUCLIDSWRQ-250 Review documentation
1 parent 90ab299 commit 2ebfc32

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

docs/esa/euclid/euclid.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -323,8 +323,8 @@ and their sky coverage (in its "fov" field) is queried using ADQL_. Please note:
323323
* Given the size of the Euclid FITS images (~1.4 GB for the MER images and ~7 GB for calibrated VIS images) downloading individual files is time consuming (depending on the internet bandwith).
324324
* This step can be skipped if using ESA Datalabs_ (as direct access to the products is possible).
325325

326-
.. doctest-skip::
327326
.. Skip testing as the example requires a lot of time to download a huge file
327+
.. doctest-skip::
328328

329329
>>> file_name = res['file_name'][0]
330330
>>> print("Downloading file:", file_name)
@@ -356,12 +356,14 @@ and their sky coverage (in its "fov" field) is queried using ADQL_. Please note:
356356
:height: 500px
357357
:scale: 100%
358358

359-
The Euclid archive provides the VO Simple Image Access Protocol (SIAP) v2.0 to access the Euclid Observation Images. This service returns public images from:
359+
The Euclid Archive provides the VO Simple Image Access Protocol (SIAP) v2.0 service for accessing Euclid observation images. This service returns public images from:
360360

361-
1. calibrated and Stacked NISP and VIS images;
362-
2. MER Mosaics from VIS and NISP.
361+
1. Calibrated and stacked NISP and VIS images.
362+
2. MER mosaics from VIS and NISP.
363363

364-
This service returns the votable that contains all the necessary information to be used by the cutout function: the path to the fits files (file_name), the instrument, and id (obs_id). Note that the votable can also saved for a latter usage.
364+
The service returns a VOTable containing all the information required by the cutout function, including the path to the FITS files (file_name), the instrument, and the observation identifier (obs_id).
365+
366+
The VOTable can also be saved for later use.
365367

366368
>>> from astroquery.esa.euclid import Euclid
367369
>>> from astropy.coordinates import SkyCoord
@@ -400,7 +402,7 @@ This service returns the votable that contains all the necessary information to
400402
https://eas.esac.esa.int/sas-cutout/cutout?filepath=/euclid/repository_idr/iqr1/Q1_R1/MER/102158889/NISP/EUC_MER_BGSUB-MOSAIC-NIR-Y_TILE102158889-AC6585_20241024T225321.344048Z_00.00.fits&collection=NISP&tileindex=102158889&POS=CIRCLE,267.78,65.53,0.01 ...
401403
https://eas.esac.esa.int/sas-cutout/cutout?filepath=/euclid/repository_idr/iqr1/Q1_R1/MER/102158889/VIS/EUC_MER_BGSUB-MOSAIC-VIS_TILE102158889-F95D3B_20241025T024806.508980Z_00.00.fits&collection=VIS&tileindex=102158889&POS=CIRCLE,267.78,65.53,0.01 ...
402404

403-
The path of the fits file can be obtained by a simple regular expression.
405+
The path to the FITS file can be extracted from the response using a simple regular expression.
404406

405407
>>> import re
406408
>>> p = re.compile(r"filepath=(.*?)&")
@@ -430,8 +432,8 @@ It is also possible to download just small portions of the MER (background subtr
430432

431433
Download the cutout...
432434

433-
.. doctest-skip::
434435
.. Skip testing as the example requires a lot of time to download a huge file
436+
.. doctest-skip::
435437

436438
>>> file_path = f"{res['file_path'][0]}/{res['file_name'][0]}"
437439
>>> cutout_out = Euclid.get_cutout(file_path=file_path, coordinate='NGC 6505', radius= 0.1 * u.arcmin, output_file='ngc6505_cutout_mer.fits')
@@ -561,8 +563,8 @@ package will also be available:
561563

562564
There are several ways to log in to the Euclid archive, as detailed below:
563565

564-
.. doctest-skip::
565566
.. Skip testing as the example require authentication
567+
.. doctest-skip::
566568

567569
>>> from astroquery.esa.euclid import Euclid
568570
>>> Euclid.login_gui() # Login via graphic interface (pop-up window)
@@ -577,8 +579,8 @@ There are several ways to log in to the Euclid archive, as detailed below:
577579
All the asynchronous jobs launched by registered users are stored in the user area, which can store up to 10 GB of jobs. Therefore, it is recommended to remove unnecessary jobs to avoid filling up the user quota.
578580
The example below shows how to delete all the jobs in the user area using the list_async_jobs and remove_jobs_ methods.
579581

580-
.. doctest-skip::
581582
.. Skip testing as the example require authentication
583+
.. doctest-skip::
582584

583585
>>> Euclid.login()
584586
>>> job_ids = [job.jobid for job in Euclid.list_async_jobs()]
@@ -589,8 +591,8 @@ It is also possible to take advantage of the job metadata to delete all the jobs
589591

590592
First, use the load_async_job_ method to download the metadata of the async jobs stored in the user space:
591593

592-
.. doctest-skip::
593594
.. Skip testing as the example require authentication
595+
.. doctest-skip::
594596

595597
>>> job_obj = [Euclid.load_async_job(jobid=jobid) for jobid in job_ids]
596598
>>> job_ids = [job.jobid for job in job_obj]
@@ -607,8 +609,8 @@ Second, create a dataframe that contains the jobid and date information:
607609

608610
Finally, extract the job id's included in a given time range (in the example below, all the jobs stored since 2024-10-01 at 7 hours UTC) and delete them:
609611

610-
.. doctest-skip::
611612
.. Skip testing as the example require authentication
613+
.. doctest-skip::
612614

613615
>>> subset = df[(df['date'] == datetime.date(2024,10,1)) & (df['hour_UTC'].isin([7]))]
614616
>>> jobs_to_delete = subset['job_id'].to_list()

0 commit comments

Comments
 (0)