Skip to content

Commit e463031

Browse files
bsipoczbsipocz
authored
Merge pull request #1943 from tinumide/casda-doc-cleanup
Casda doc clean up
2 parents cf7fe2e + c0700b8 commit e463031

File tree

1 file changed

+31
-57
lines changed

1 file changed

+31
-57
lines changed

‎docs/casda/casda.rst

Lines changed: 31 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. doctest-skip-all
2-
31
.. _astroquery.casda:
42

53
**********************************
@@ -20,39 +18,22 @@ The method takes a location and either a radius or a height and width of the reg
2018
The location should be specified in ICRS coordinates or an `astropy.coordinates.SkyCoord` object.
2119
For example:
2220

23-
.. code-block:: python
21+
.. doctest-remote-data::
2422

2523
>>> from astroquery.casda import Casda
2624
>>> from astropy.coordinates import SkyCoord
2725
>>> from astropy import units as u
2826
>>> centre = SkyCoord.from_name('NGC 7232')
2927
>>> result_table = Casda.query_region(centre, radius=30*u.arcmin)
30-
>>> print(result_table['obs_publisher_did','s_ra', 's_dec', 'obs_release_date'])
31-
obs_publisher_did s_ra s_dec obs_release_date
28+
>>> print(result_table['obs_publisher_did','s_ra', 's_dec', 'obs_release_date'][:5])
29+
obs_publisher_did s_ra s_dec obs_release_date
3230
deg deg
3331
----------------- --------------- ---------------- ------------------------
34-
cube-502 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
35-
cube-503 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
36-
cube-504 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
37-
cube-505 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
38-
cube-506 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
39-
cube-507 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
40-
cube-508 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
41-
cube-453 332.53629746595 -44.850153699406 2017-07-10T05:18:13.482Z
42-
cube-454 332.53629746595 -44.850153699406 2017-07-10T05:18:13.482Z
43-
cube-455 332.53629746595 -44.850153699406 2017-07-10T05:18:13.482Z
44-
... ... ... ...
45-
cube-468 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
46-
cube-469 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
47-
cube-470 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
48-
cube-471 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
49-
cube-472 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
50-
cube-473 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
51-
cube-1170 333.70448386919 -45.966341151806 2019-01-30T13:00:00.000Z
52-
cube-612 333.30189344648 -50.033321773361 2018-05-25T08:22:51.025Z
53-
cube-650 326.04487794126 -42.033324601808
54-
cube-651 335.54487794126 -42.033324601808
55-
Length = 121 rows
32+
cube-11460 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
33+
cube-11461 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
34+
cube-11462 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
35+
cube-11463 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
36+
cube-11464 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
5637

5738

5839
In most cases only public data is required. While most ASKAP data is public, some data products may not be released for quality reasons.
@@ -61,47 +42,38 @@ To filter down to just the public data you can use the :meth:`~astroquery.casda.
6142

6243
For example to filter out the 30 non-public results from the above data set:
6344

64-
.. code-block:: python
45+
.. doctest-remote-data::
6546

6647
>>> public_results = Casda.filter_out_unreleased(result_table)
67-
>>> print(public_results['obs_publisher_did','s_ra', 's_dec', 'obs_release_date'])
68-
obs_publisher_did s_ra s_dec obs_release_date
48+
>>> print(public_results['obs_publisher_did','s_ra', 's_dec', 'obs_release_date'][:5])
49+
obs_publisher_did s_ra s_dec obs_release_date
6950
deg deg
7051
----------------- --------------- ---------------- ------------------------
71-
cube-502 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
72-
cube-503 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
73-
cube-504 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
74-
cube-505 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
75-
cube-506 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
76-
cube-507 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
77-
cube-508 333.16767306594 -45.302084636451 2017-08-02T03:51:19.728Z
78-
cube-453 332.53629746595 -44.850153699406 2017-07-10T05:18:13.482Z
79-
cube-454 332.53629746595 -44.850153699406 2017-07-10T05:18:13.482Z
80-
cube-455 332.53629746595 -44.850153699406 2017-07-10T05:18:13.482Z
81-
... ... ... ...
82-
cube-468 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
83-
cube-469 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
84-
cube-470 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
85-
cube-471 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
86-
cube-472 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
87-
cube-473 332.53644868638 -44.834926604835 2017-07-10T05:18:48.812Z
88-
cube-1170 333.70448386919 -45.966341151806 2019-01-30T13:00:00.000Z
89-
cube-612 333.30189344648 -50.033321773361 2018-05-25T08:22:51.025Z
90-
Length = 81 rows
52+
cube-11460 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
53+
cube-11461 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
54+
cube-11462 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
55+
cube-11463 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
56+
cube-11464 326.52250211117 -43.891190432671 2020-11-18T09:49:27.134Z
9157

9258

9359
Authentication
9460
==============
9561

96-
User authentication is required to access data files from CASDA, including calibrated visibilities, images and image cubes.
62+
User authentication is required to access data files from CASDA, including
63+
calibrated visibilities, images and image cubes.
9764
Authentication is made with OPAL credentials.
98-
To register with OPAL, go to https://opal.atnf.csiro.au/ and click on the link to 'Register'. Enter your email address, name, affiliation and a password. The OPAL application will register you straight away.
65+
To register with OPAL, go to https://opal.atnf.csiro.au/ and click on the
66+
link to 'Register'. Enter your email address, name, affiliation and a password.
67+
The OPAL application will register you straight away.
9968

100-
OPAL user accounts are self-managed. Please keep your account details up to date. To change user-registration details, or to request a new OPAL password, use the link to 'Log in or reset password'.
69+
OPAL user accounts are self-managed. Please keep your account details up to
70+
date. To change user-registration details, or to request a new OPAL password,
71+
use the link to 'Log in or reset password'.
10172

102-
To use download tasks, you should create an instance of the Casda object with a username and password. e.g.:
73+
To use download tasks, you should create an instance of the ``Casda`` class
74+
with a username and password. e.g.:
10375

104-
.. code-block:: python
76+
.. doctest-skip::
10577

10678
>>> from astroquery.casda import Casda
10779
>>> import getpass
@@ -121,8 +93,10 @@ This column should contain the datalink address of the data product.
12193
Once the data has been assembled you can then download the data using the :meth:`~astroquery.casda.CasdaClass.download_files` method, or using tools such as wget.
12294
Authentication is required when staging the data, but not for the download.
12395

124-
An example script to download public continuum images of the NGC 7232 region taken in scheduling block 2338 is shown below:
125-
.. code-block:: python
96+
An example script to download public continuum images of the NGC 7232 region
97+
taken in scheduling block 2338 is shown below:
98+
99+
.. doctest-skip::
126100

127101
>>> from astropy import coordinates, units as u, wcs
128102
>>> from astroquery.casda import Casda

0 commit comments

Comments
 (0)