Permalink
Browse files

documentation updated

  • Loading branch information...
1 parent 9db35ea commit d27fdc5fe696cbae58b8affabeaeffe1205b2497 @leejjoon committed Aug 4, 2009
Showing with 65 additions and 4 deletions.
  1. +19 −0 LICENSE.txt
  2. +18 −0 README
  3. +11 −2 doc/users/installing.rst
  4. +17 −2 doc/users/overview.rst
View
@@ -0,0 +1,19 @@
+Copyright (c) 2009, Jae-Joon Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
@@ -0,0 +1,18 @@
+pywcsgrid2
+==========
+
+pywcsgrid2 is a python module to be used with matplotlib for
+displaying astronomical fits images. It provides a custom Axes class
+(derived from mpl��s original Axes class) suitable for displaying fits
+images. Its main functionality is to draw ticks, ticklabels, and grids
+in an appropriate sky coordinates.
+
+Homepage : http://leejjoon.github.com/pywcsgrid2/
+
+LICENSE
+-------
+
+lib/kapteyn_celestial.py : from kapteyn package. See LICENSE_kapteyn.txt.
+
+All other files: MIT License. See LICENSE.txt
+
@@ -11,14 +11,23 @@ Dependencies
pywcsgrid2 is a python module that extends functionality of
matplotlib, i.e., you need python with matplotlib installed. Note that
-you need svn version of matplotlib which includes AxesGrid
-toolkit. Furthermore, you need the Kapteyn package installed.
+you need at least 0.99.0 (or from svn) version of matplotlib which
+includes AxesGrid toolkit. The pyfits package is required to read fits files.
+Furthermore, you need either Kapteyn package or pywcs (from svn) installed.
matplotlib
----------
* `Homepage <http://matplotlib.sourceforge.net/>`__
* `install from svn <http://matplotlib.sourceforge.net/faq/installing_faq.html#install-svn>`__
+* `0.99.0rc1 <http://www.nabble.com/matplotlib-0.99.0-rc1-%3A-call-for-testing-tt24760373.html>`__ : Check the mailing list or the home page for more recent version.
+
+pywcs
+-----
+* used for coordinate conversions
+* `Homepage <https://www.stsci.edu/trac/ssb/astrolib>`__
+* The current release does not work (v1.5.1-4.3.3, released July 9,
+ 2009). You need to install from svn.
Kapteyn Package
---------------
@@ -9,8 +9,10 @@ matplotlib, instead of creating a new tool on top of the matplotlib.
In essence, it provides a custom Axes class (derived from mpl's
original Axes class) suitable for displaying fits images. Its main
functionality is to draw ticks, ticklabels, and grids in an
-appropriate sky coordinates. You require pyfits and kapteyn package
-installed, in addition to matplotlib (you need to use svn version).
+appropriate sky coordinates. A recent version of the matplotlib (>
+0.99.0) is required which includes axes_grid toolkit. In addition to
+pyfits, you need either pywcs (from svn) or kapteyn package installed.
+See :ref:`installing` for more detailes.
.. contents::
:depth: 1
@@ -182,6 +184,19 @@ Here is a complete example,
.. plot:: figures/demo_floating_axis.py
+Inset Axes
+==========
+
+pywcsgrid2 itself does not provide any particular functionality to
+support inset axes. However, inset axes is supported by the axes_grid
+toolkit, which can be seemingless utilized with pywcsgrid2. See
+`axes_grid toolkit documentation
+<http://matplotlib.sourceforge.net/mpl_toolkits/axes_grid/users/overview.html#insetlocator>`__
+for more details.
+
+.. plot:: figures/demo_inset.py
+
+
Axes Annotation
===============

0 comments on commit d27fdc5

Please sign in to comment.