Simplify import in docs examples

hipspy · Jul 20, 2017 · fe19120 · fe19120
1 parent 438bbe4
commit fe19120
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 17 deletions.
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -18,7 +18,7 @@ To make a sky image with the `hips` package, follow the following three steps:
 1. Specify the sky image geometry you want by creating a `~hips.utils.WCSGeometry` object::
 
     from astropy.coordinates import SkyCoord
-    from hips.utils import WCSGeometry
+    from hips import WCSGeometry
 
     geometry = WCSGeometry.create(
          skydir=SkyCoord(0, 0, unit='deg', frame='galactic'),
@@ -31,15 +31,15 @@ To make a sky image with the `hips` package, follow the following three steps:
 
    A good address that lists available HiPS data is http://aladin.u-strasbg.fr/hips/list ::
 
-    from hips.tiles import HipsSurveyProperties
+    from hips import HipsSurveyProperties
     url = 'http://alasky.unistra.fr/DSS/DSS2Merged/properties'
     hips_survey = HipsSurveyProperties.fetch(url)
 
 
 3. Call the `~hips.make_sky_image` function to fetch the HiPS data
    and draw it, returning the sky image pixel data as a Numpy array::
 
-    from hips.draw import make_sky_image
+    from hips import make_sky_image
 
     data = make_sky_image(geometry, hips_survey, 'fits')
 

diff --git a/docs/plot_fits.py b/docs/plot_fits.py
@@ -1,8 +1,6 @@
 """Basic example how to plot a sky image with the hips package"""
 from astropy.coordinates import SkyCoord
-from hips import HipsSurveyProperties
-from hips import make_sky_image
-from hips.utils import WCSGeometry
+from hips import WCSGeometry, HipsSurveyProperties, make_sky_image
 
 # Compute the sky image
 url = 'http://alasky.unistra.fr/DSS/DSS2Merged/properties'

diff --git a/docs/plot_jpg.py b/docs/plot_jpg.py
@@ -1,8 +1,6 @@
 """Basic example how to plot a sky image with the hips package"""
 from astropy.coordinates import SkyCoord
-from hips import HipsSurveyProperties
-from hips import make_sky_image
-from hips.utils import WCSGeometry
+from hips import WCSGeometry, HipsSurveyProperties, make_sky_image
 
 # Compute the sky image
 url = 'http://alasky.u-strasbg.fr/Fermi/Color/properties'

diff --git a/hips/draw/simple.py b/hips/draw/simple.py
@@ -35,17 +35,17 @@ class SimpleTilePainter:
 
     Examples
     --------
-    >>> from hips.utils import WCSGeometry
-    >>> from hips.draw import SimpleTilePainter
-    >>> from hips.tiles import HipsSurveyProperties
     >>> from astropy.coordinates import SkyCoord
-    >>> url = 'http://alasky.unistra.fr/DSS/DSS2Merged/properties'
-    >>> hips_survey = HipsSurveyProperties.fetch(url)
+    >>> from hips import WCSGeometry
+    >>> from hips import HipsSurveyProperties
+    >>> from hips import SimpleTilePainter
     >>> geometry = WCSGeometry.create(
     ...     skydir=SkyCoord(0, 0, unit='deg', frame='icrs'),
     ...     width=2000, height=1000, fov='3 deg',
     ...     coordsys='icrs', projection='AIT',
     ... )
+    >>> url = 'http://alasky.unistra.fr/DSS/DSS2Merged/properties'
+    >>> hips_survey = HipsSurveyProperties.fetch(url)
     >>> painter = SimpleTilePainter(geometry, hips_survey, 'fits')
     >>> painter.draw_hips_order
     7

diff --git a/hips/tiles/tile.py b/hips/tiles/tile.py
@@ -38,7 +38,7 @@ class HipsTileMeta:
 
     Examples
     --------
-    >>> from hips.tiles import HipsTileMeta
+    >>> from hips import HipsTileMeta
     >>> tile_meta = HipsTileMeta(order=3, ipix=450, file_format='fits', frame='icrs')
     >>> tile_meta
     HipsTileMeta(order=3, ipix=450, file_format='fits', frame='icrs')
@@ -104,7 +104,7 @@ class HipsTile:
 
     Fetch a HiPS tile:
 
-    >>> from hips.tiles import HipsTile, HipsTileMeta
+    >>> from hips import HipsTile, HipsTileMeta
     >>> meta = HipsTileMeta(order=6, ipix=30889, file_format='fits')
     >>> url = 'http://alasky.unistra.fr/2MASS/H/Norder6/Dir30000/Npix30889.fits'
     >>> tile = HipsTile.fetch(meta, url)

diff --git a/hips/utils/healpix.py b/hips/utils/healpix.py
@@ -104,7 +104,7 @@ def healpix_pixels_in_sky_image(geometry: WCSGeometry, order: int, healpix_frame
     Examples
     --------
     >>> from astropy.coordinates import SkyCoord
-    >>> from hips.utils import WCSGeometry
+    >>> from hips import WCSGeometry
     >>> from hips.utils import healpix_pixels_in_sky_image
     >>> skycoord = SkyCoord(10, 20, unit="deg")
     >>> geometry = WCSGeometry.create(