Merge pull request #763 from imbasimba/master

Esasky minor documentation change

Author: keflavich

README.rst

@@ -82,6 +82,7 @@ List of Modules
 
   * `Simbad <http://astroquery.readthedocs.io/en/latest/simbad/simbad.html>`_:           Basic data, cross-identifications, bibliography and measurements for astronomical objects outside the solar system.
   * `Vizier <http://astroquery.readthedocs.io/en/latest/vizier/vizier.html>`_:           Set of 11,000+ published, multiwavelength catalogues hosted by the CDS.
+  * `ESASky <http://astroquery.readthedocs.io/en/latest/esasky/esasky.html>`_:           ESASky is a science driven discovery portal providing easy visualizations and full access to the entire sky as observed with ESA Space astronomy missions.
   * `IRSA Image Server program interface (IBE) Query Tool<http://astroquery.readthedocs.io/en/latest/ibe/ibe.html>`_: provides access to the 2MASS, WISE, and PTF image archives.
   * `IRSA dust <http://astroquery.readthedocs.io/en/latest/irsa/irsa_dust.html>`_:     Galactic dust reddening and extinction maps from IRAS 100 um data.
   * `NED <http://astroquery.readthedocs.io/en/latest/ned/ned.html>`_:                 NASA/IPAC Extragalactic Database. Multiwavelength data from both surveys and publications.

astroquery/esasky/core.py

@@ -278,7 +278,7 @@ def query_region_catalogs(self, position, radius, catalogs=__ALL_STRING,
         return commons.TableList(query_result)
 
     def get_maps(self, query_table_list, missions=__ALL_STRING, 
-                 download_directory=__MAPS_STRING, cache=True):
+                 download_dir=__MAPS_STRING, cache=True):
         """
         This method takes the dictionary of missions and metadata as returned by 
         query_region_maps and downloads all maps to the selected folder. 
@@ -296,7 +296,7 @@ def get_maps(self, query_table_list, missions=__ALL_STRING,
             Can be either a specific mission or a list of missions (all mission 
             names are found in list_missions()) or 'all' to search in all 
             missions. Defaults to 'all'. 
-        download_directory : string, optional
+        download_dir : string, optional
             The folder where all downloaded maps should be stored. 
             Defaults to a folder called 'Maps' in the current working directory. 
         cache : bool, optional
@@ -339,11 +339,11 @@ def get_maps(self, query_table_list, missions=__ALL_STRING,
                         self._get_maps_for_mission(
                             sanitized_query_table_list[query_mission], 
                             query_mission, 
-                            download_directory, 
+                            download_dir, 
                             cache))
                     break
         if (len(sanitized_query_table_list) > 0):
-            log.info("Maps available at %s" %os.path.abspath(download_directory))
+            log.info("Maps available at %s" %os.path.abspath(download_dir))
         else:
             print("No maps found")
         return maps

docs/esasky/esasky.rst

@@ -25,9 +25,9 @@ If you know the names of all the available catalogs you can use
 
     >>> catalog_list = ESASky.list_catalogs()
     >>> print(catalog_list)
-		['INTEGRAL', 'XMM-EPIC', 'XMM-OM', 'XMM-SLEW', 'Tycho-2', 
-		'Gaia DR1 TGAS', 'Hipparcos-2', 'HSC', 'Planck-PGCC2', 'Planck-PCCS2E', 
-		'Planck-PCCS2-HFI', 'Planck-PCCS2-LFI', 'Planck-PSZ']
+	['INTEGRAL', 'XMM-EPIC', 'XMM-OM', 'XMM-SLEW', 'Tycho-2', 
+	'Gaia DR1 TGAS', 'Hipparcos-2', 'HSC', 'Planck-PGCC2', 'Planck-PCCS2E', 
+	'Planck-PCCS2-HFI', 'Planck-PCCS2-LFI', 'Planck-PSZ']
 
 Get the available maps mission names
 ------------------------------------
@@ -39,8 +39,8 @@ If you know the names of all the available maps missions you can use
 
     >>> maps_list = ESASky.list_maps()
     >>> print(maps_list)
-    	['INTEGRAL', 'XMM-EPIC', 'SUZAKU', 'XMM-OM-OPTICAL', 'XMM-OM-UV', 
-    	'HST', 'Herschel', 'ISO']
+	['INTEGRAL', 'XMM-EPIC', 'SUZAKU', 'XMM-OM-OPTICAL', 'XMM-OM-UV', 
+	'HST', 'Herschel', 'ISO']
 
 Query an object
 ---------------
@@ -209,36 +209,36 @@ dictionary where the used filter is the key and the HDUList is the value.
 	
     >>> print(images)
  	{
-    'HERSCHEL': [{'70': [HDUList], ' 160': [HDUList]}, {'70': [HDUList], ' 160': [HDUList]}, ...],
-    'XMM-EPIC' : [HDUList], HDUList], HDUList], HDUList], ...]
-    ...
-    }
+	'HERSCHEL': [{'70': [HDUList], ' 160': [HDUList]}, {'70': [HDUList], ' 160': [HDUList]}, ...],
+	'XMM-EPIC' : [HDUList], HDUList], HDUList], HDUList], ...]
+	...
+	}
 
 Note that the fits files also are stored to disk. By default they are saved to 
-the working directory but the location can be chosen by the download_directory 
+the working directory but the location can be chosen by the download_dir 
 parameter:
 
 .. code-block:: python
 
-    >>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], download_directory="/home/user/esasky")
+    >>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], download_dir="/home/user/esasky")
 
 Get maps
 --------
 
 You can also fetch images using :meth:`astroquery.esasky.ESASkyClass.get_maps`. 
 It works exactly as :meth:`astroquery.esasky.ESASkyClass.get_images` except that 
-it takes a `~astropy.utils.TableList` instead of position, radius and missions. 
+it takes a `~astroquery.utils.TableList` instead of position, radius and missions. 
 
 .. code-block:: python
 
     >>> table_list = ESASky.query_region_maps("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'])
-    >>> images = ESASky.get_maps(table_list, download_directory="/home/user/esasky")
+    >>> images = ESASky.get_maps(table_list, download_dir="/home/user/esasky")
 
 This example is equivalent to:
 
 .. code-block:: python
 
-    >>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], download_directory="/home/user/esasky")
+    >>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], download_dir="/home/user/esasky")
 
 
 Reference/API