Skip to content

Commit 8444e9f

Browse files
committed
add 'help' to docs
1 parent 67527ff commit 8444e9f

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

docs/alma/alma.rst

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,44 @@ Getting started
1212
`astroquery.alma` provides the astroquery interface to the ALMA archive. It
1313
supports object and region based querying and data staging and retrieval.
1414

15+
You can get interactive help to find out what keywords to query for:
16+
17+
.. code-block:: python
18+
19+
>>> from astroquery.alma import Alma
20+
>>> Alma.help()
21+
Valid ALMA keywords:
22+
23+
Position
24+
Source name (Sesame) : source_name_sesame
25+
Source name (ALMA) : source_name-asu
26+
RA Dec : raDecCoordinates
27+
28+
Energy
29+
Frequency : energy.frequency-asu
30+
Bandwidth : energy.bandwidth-asu
31+
Spectral resolution : energy.resolution-asu
32+
Band : band-asu
33+
34+
Time
35+
Observation date : start_date-asu
36+
Integration time : int_time-asu
37+
38+
Polarisation
39+
Polarisation type : energy.pol_num-asu
40+
41+
Observation
42+
Water vapour : pwv-asu
43+
44+
Project
45+
Project code : project_code-asu
46+
Project title : project.title-substr
47+
PI name : project.pi_name-substr
48+
49+
Options
50+
View: : viewFormat
51+
[x] public data only : publicFilterFlag = public
52+
[x] science observations only : scan_intent-asu = =%TARGET%
1553
1654
Authentication
1755
==============
@@ -111,7 +149,7 @@ UIDs):
111149
112150
You can then go on to download that data. The download will be cached so that repeat
113151
queries of the same file will not re-download the data. The default cache
114-
directory is `~/.astropy/cache/astroquery/Alma/`, but this can be changed by
152+
directory is ``~/.astropy/cache/astroquery/Alma/``, but this can be changed by
115153
changing the ``cache_location`` variable:
116154

117155
.. code-block:: python

0 commit comments

Comments
 (0)