Skip to content

Commit

Permalink
Merge pull request #1970 from tinumide/esa-doc-cleanup
Browse files Browse the repository at this point in the history
Esa documentation cleanup
  • Loading branch information
bsipocz authored Aug 17, 2022
2 parents 68d233a + 81f9ef2 commit 1dea6ac
Show file tree
Hide file tree
Showing 6 changed files with 512 additions and 409 deletions.
2 changes: 1 addition & 1 deletion astroquery/esa/hubble/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ def cone_search(self, coordinates, radius, filename=None,
"pl.main_science_plane='true' and 1=CONTAINS(POINT('ICRS', "
f"pos.ra, pos.dec),CIRCLE('ICRS', {str(ra)}, {str(dec)}, {str(radius_in_grades)})) order "
"by prop.proposal_id desc")
print("type: " + str(type(query)))

if verbose:
log.info(query)
table = self.query_hst_tap(query=query, async_job=async_job,
Expand Down
15 changes: 9 additions & 6 deletions docs/esa/hsa/hsa.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,17 @@ Examples
1. Getting Herschel data
------------------------

.. doctest-remote-data::
.. Skipping becuase of how long the download takes
.. doctest-skip::

>>> from astroquery.esa.hsa import HSA
>>>
>>> HSA.download_data(observation_id='1342195355',retrieval_type='OBSERVATION', instrument_name='PACS') # doctest: +IGNORE_OUTPUT
>>> HSA.download_data(observation_id='1342195355', retrieval_type='OBSERVATION',
... instrument_name='PACS')
Downloading URL http://archives.esac.esa.int/hsa/whsa-tap-server/data?&retrieval_type=OBSERVATION&observation_id=1342195355&instrument_name=PACS to 1342195355.tar ... [Done]
'1342195355.tar'

This will download the product of the observation '1342195355' with the instrument 'PACS' and
This will download the products of the observation '1342195355' with the instrument 'PACS' and
it will store them in a tar called '1342195355.tar'. The parameters available are detailed in the API.

For more details of the parameters check the section 6 of the ``Direct Product Access using TAP`` in the
Expand All @@ -41,11 +43,12 @@ For more details about the products check:
2. Getting Observation Products
-------------------------------

.. doctest-remote-data::
.. Skipping becuase of how long the download takes
.. doctest-skip::

>>> from astroquery.esa.hsa import HSA
>>>
>>> HSA.get_observation('1342195355', instrument_name='PACS') # doctest: +IGNORE_OUTPUT
>>> HSA.get_observation('1342195355', instrument_name='PACS')
Downloading URL http://archives.esac.esa.int/hsa/whsa-tap-server/data?&retrieval_type=OBSERVATION&observation_id=1342195355&instrument_name=PACS to 1342195355.tar ... [Done]
'1342195355.tar'

Expand Down Expand Up @@ -245,4 +248,4 @@ Reference/API
.. testcleanup::

>>> from astroquery.utils import cleanup_saved_downloads
>>> cleanup_saved_downloads(['1342195355*', 'results.csv'])
>>> cleanup_saved_downloads(['1342195355*', 'results.csv'])
Loading

0 comments on commit 1dea6ac

Please sign in to comment.