README

   1 igor: Interface for reading binary IGOR files.
   2
   3 Read Igor Binary Waves (.ibw) and ... written by WaveMetrics' IGOR
   4 package.
   5
   6 Installation
   7 ============
   8
   9 Packages
  10 --------
  11
  12 Gentoo
  13 ~~~~~~
  14
  15 I've packaged `igor` for Gentoo.  You need layman_ and my `wtk
  16 overlay`_.  Install with::
  17
  18     # emerge -av app-portage/layman
  19     # layman --add wtk
  20     # emerge -av sci-misc/igor
  21
  22 Dependencies
  23 ------------
  24
  25 If you're installing by hand or packaging calibcant for another
  26 distribution, you'll need the following dependencies:
  27
  28 ===========  =================  ============================
  29 Package      Debian_            Gentoo_
  30 ===========  =================  ============================
  31 Numpy_       python-numpy       dev-python/numpy
  32 Matplotlib_  python-matplotlib  dev-python/matplotlib
  33 Nose_        python-nose        dev-python/nose
  34 ===========  =================  ============================
  35
  36 Installing by hand
  37 ------------------
  38
  39 `igor` is available as a Git_ repository::
  40
  41     $ git clone git://tremily.us/igor.git
  42
  43 See the homepage_ for details.  To install the checkout, run the
  44 standard::
  45
  46     $ python setup.py install
  47
  48
  49 Usage
  50 =====
  51
  52 See the module docstrings for simple examples.
  53
  54
  55 Testing
  56 =======
  57
  58 Run internal unit tests with::
  59
  60     $ nosetests --with-doctest --doctest-tests igor
  61
  62
  63 Licence
  64 =======
  65
  66 This project is distributed under the `GNU General Public License
  67 Version 3`_ or greater.
  68
  69
  70 Author
  71 ======
  72
  73 W. Trevor King
  74 wking@tremily.us
  75 Copyright 2008-2012
  76
  77
  78 .. _layman: http://layman.sourceforge.net/
  79 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
  80 .. _Debian: http://www.debian.org/
  81 .. _Gentoo: http://www.gentoo.org/
  82 .. _NumPy: http://numpy.scipy.org/
  83 .. _Matplotlib: http://matplotlib.sourceforge.net/
  84 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
  85 .. _Git: http://git-scm.com/
  86 .. _homepage: http://blog.tremily.us/posts/calibcant/
  87 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt