Skip to content

Commit 48a6c88

Browse files
committed
initial docs: wip, they're only 1/4 done
1 parent 4dc7f33 commit 48a6c88

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/alma/alma.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. doctest-skip-all
2+
3+
.. _astroquery.alma:
4+
5+
********************************
6+
ALMA Queries (`astroquery.alma`)
7+
********************************
8+
9+
Getting started
10+
===============
11+
12+
`astroquery.alma` provides the astroquery interface to the ALMA archive. It
13+
supports object and region based querying and data staging and retrieval.
14+
15+
16+
Authentication
17+
==============
18+
19+
Users can log in to acquire proprietary data products. Login is performed
20+
via the ALMA CAS (central authentication server).
21+
22+
.. code-block:: python
23+
24+
>>> from astroquery.alma import Alma
25+
>>> alma = Alma()
26+
>>> alma("TEST") # doctest: +SKIP
27+
TEST, enter your ALMA password:
28+
29+
Authenticating TEST on asa.alma.cl...
30+
Authentication failed!
31+
>>> alma.login("ICONDOR") # doctest: +SKIP
32+
ICONDOR, enter your ESO password:
33+
34+
Authenticating ICONDOR on asa.alma.cl...
35+
Authentication successful!
36+
>>> alma.login("ICONDOR") # doctest: +SKIP
37+
Authenticating ICONDOR on asa.alma.cl...
38+
Authentication successful!
39+
40+

0 commit comments

Comments
 (0)