summaryrefslogtreecommitdiffstats
path: root/funtools/README
diff options
context:
space:
mode:
authorWilliam Joye <wjoye@cfa.harvard.edu>2016-10-27 17:38:41 (GMT)
committerWilliam Joye <wjoye@cfa.harvard.edu>2016-10-27 17:38:41 (GMT)
commit5b44fb0d6530c4ff66a446afb69933aa8ffd014f (patch)
treee059f66d1f612e21fe9d83f9620c8715530353ec /funtools/README
parentda2e3d212171bbe64c1af39114fd067308656990 (diff)
parent23c7930d27fe11c4655e1291a07a821dbbaba78d (diff)
downloadblt-5b44fb0d6530c4ff66a446afb69933aa8ffd014f.zip
blt-5b44fb0d6530c4ff66a446afb69933aa8ffd014f.tar.gz
blt-5b44fb0d6530c4ff66a446afb69933aa8ffd014f.tar.bz2
Merge commit '23c7930d27fe11c4655e1291a07a821dbbaba78d' as 'funtools'
Diffstat (limited to 'funtools/README')
-rw-r--r--funtools/README27
1 files changed, 27 insertions, 0 deletions
diff --git a/funtools/README b/funtools/README
new file mode 100644
index 0000000..973e6b0
--- /dev/null
+++ b/funtools/README
@@ -0,0 +1,27 @@
+Funtools is a "minimal buy-in" FITS library and utility package
+originally developed at the the High Energy Astrophysics Division of
+SAO. Although no longer actively supported at SAO, it is still widely
+used within the astronomical community, especially among X-ray astronomers.
+
+The Funtools library provides simplified access to a wide array
+of file types: standard astronomical FITS images and binary tables,
+raw arrays and binary event lists, and even tables of ASCII column
+data. A sophisticated region filtering library (compatible with ds9)
+filters images and tables using Boolean operations between geometric
+shapes, support world coordinates, etc. Funtools also supports
+advanced capabilities such as optimized data searching using index files.
+
+Because Funtools consists of a library and a set of user programs, it
+is most appropriately built from source. Funtools has been ported to
+Solaris, Linux, Mac OSX (Darwin) and Windows 98/NT/2000/XP. Once the
+source code tar file is retrieved, Funtools can be built and installed
+easily using standard commands:
+
+ ./mkconfigure # generate all configure scripts
+ ./configure --prefix=[installdir] # configuration
+ make # build the software
+ make install # install in [installdir]
+
+See the INSTALL instructions (which are based on standard instructions
+for building software using GNU configure) for more information about
+building Funtools.