–
$Id$
This file includes an RDoc hack so that links can be made to open up into a new frame rather then the current frame.
The “trick” is to append ““target=”_top” to the URL.
++
MIRIAD-Ruby
Introduction
The MIRIAD-Ruby package…
-
Makes MIRIAD datasets accessible from Ruby by wrapping the MIRIAD UVIO routines.
-
Makes Ruby usable with MIRIAD datasets by adding convenience, utility, and astronomy related methods to Ruby classes.
Installation
MIRIAD-Ruby can be installed in three easy steps.
-
Install Ruby. See the Ruby Download Page for instructions.
-
Install RubyGems (for Ruby < 1.9.0) See the RubyGems web site for instructions.
-
Install MIRIAD-Ruby by running…
gem install miriad
or
sudo gem install miriad
Documentation
You are reading part of it!
On the web
The latest documentation is published on the MIRIAD-Ruby Home Page
At your local site
The MIRIAD-Ruby gem contains full documentation, which will be installed along with the gem (unless you specified --no-rdoc
or --no-ri
, but why would you do that?).
To view the local HTML documentation generated from the RDoc comments:
-
Run
gem server
. -
Point your browser at
http://localhost:8808/
-
Find the
miriad
entry. -
Click on the [rdoc] link.
To view the local ri
documentation (kind if like man
or info
for Ruby), just run ri class_or_method
. For example, to find out about all the ways to call read()
, type ri Miriad::Uvio#read
.
Further Reading
Additional information about MIRIAD-Ruby can be found at:
Additional information about MIRIAD can be found at:
Acknowledgements
The MIRAD-Ruby package is distributed with a snapshot of MIRIAD’s lower level I/O routines writtin in ANSI C. Most of the MIRIAD functionality provided by MIRIAD-Ruby is actually performed by this C code, which MIRIAD-Ruby wraps and exposes to Ruby.
Much of the documentation for the Miriad::Uvio routines was transcribed into Rdoc format from {The Miriad Programmer’s Guide }[http://www.atnf.csiro.au/computing/software/miriad/progguide/progguide.html“target=”_top].
Authors too numerous to list (and too likely to prefer anonymity) have contributed to both the C code and the documentation. If you are one of them and would like to be mentioned here, please file a bug report on the MIRIAD-Ruby Rubyforge project page.
– # vim: set expandtab ts=2 sw=2 smarttab syntax=ruby autoindent fo+=taroq2 :