INSTALL

   1 CTSim Installation
   2 ==================
   3
   4 Additional Libraries Recommended
   5 --------------------------------
   6
   7 zlib (ftp://ftp.uu.net/pub/archiving/zip/zlib)
   8   Tested with version 1.13
   9   This library is required for libpng (see below)
  10
  11 libpng (ftp://ftp.uu.net/graphics/png/src)
  12   Version 1.0.3 or greater is required. Version 0.89 definitely will
  13   not work.
  14
  15 fftw (http://www.fftw.org)
  16   Fastest Fourier Transform in the West. Currently, this library is the
  17   only FFT routines used by CTSim.
  18
  19 wxWindows (http://www.wxwindows.org)
  20   Used by CTSim (src/*) graphic front-end. Platform independent for
  21   GTK, Motif, and Windows32 API's.
  22
  23 g2 (http://g2.sourceforge.net)
  24   Currently, used partially by SGP (Simple Graphics Package) for
  25   graphical display by command-line tools (tools/*). This library
  26   will likely be deprecated in favor of wxWindows.
  27
  28 lam (http://www.mpi.nd.edu/lam/)
  29   There is support is MPI clustering. I use this code at home for my
  30   beowulf cluster.
  31
  32 dmalloc (http://www.dmalloc.com)
  33   This adds debugging to memory allocation routines
  34
  35 perl (http://www.perl.org)
  36 apache (http://www.apache.org)
  37   There is support for web-driven CT Simulation. To use this, the
  38   --with-cgibin-dir=..., --with-cgibin-url=..., --with-webdata-dir=...,
  39   --with-webdata-url=..., and --with-html-dir=...  must be set.
  40
  41
  42 CTSim Specific Configuration Help
  43 ---------------------------------
  44
  45   --enable-verbose-warnings
  46                           Enable verbose compiler warnings.
  47   --enable-debug          Turn on debugging
  48   --with-lam[=PATH]       Set path of LAM MPI
  49   --with-cgibin-dir=PATH  Set path of CGI binaries directory
  50   --with-cgibin-url=PATH  Set URL path of CGI binaries
  51   --with-webdata-dir=PATH Set path of webdata
  52   --with-webdata-url=PATH Set URL path of webdata
  53   --with-html-dir=PATH    Set directory of html files
  54   --with-x                use the X Window System for interactive graphics
  55
  56
  57 PLATFORM SPECIFIC NOTES
  58 =======================
  59
  60 Platforms Tested
  61 ----------------
  62
  63 Recent development is with GNU/Linux. I have tested compilation on
  64 FreeBSD v4.0, BSD/OS v3.0, and Solaris v8 (gcc 32-bit), and IA64 (gcc)
  65 , and Microsoft Windows 2000 (Visual C++ 6.0, cygwin, and mingw32).
  66
  67 Visual C++ Installation
  68 -----------------------
  69 Run make.bat from the root directory (Note, make.bat is out of date
  70 and is currently broken)
  71
  72 CYGWIN v1.1.0
  73 -------------
  74 The file /usr/i686-pc-wygwin/include/cygwin/in.h has a bug. The line
  75       struct in_addr6 sin6_addr;
  76 should be deleted.
  77
  78 getopt_long appears broken, configure.in checks for cygwin to use
  79 bundled version of getopt_long.
  80
  81
  82 Basic Installation
  83 ==================
  84
  85    These are generic installation instructions.
  86
  87    The `configure' shell script attempts to guess correct values for
  88 various system-dependent variables used during compilation.  It uses
  89 those values to create a `Makefile' in each directory of the package.
  90 It may also create one or more `.h' files containing system-dependent
  91 definitions.  Finally, it creates a shell script `config.status' that
  92 you can run in the future to recreate the current configuration, a file
  93 `config.cache' that saves the results of its tests to speed up
  94 reconfiguring, and a file `config.log' containing compiler output
  95 (useful mainly for debugging `configure').
  96
  97    If you need to do unusual things to compile the package, please try
  98 to figure out how `configure' could check whether to do them, and mail
  99 diffs or instructions to the address given in the `README' so they can
 100 be considered for the next release.  If at some point `config.cache'
 101 contains results you don't want to keep, you may remove or edit it.
 102
 103    The file `configure.in' is used to create `configure' by a program
 104 called `autoconf'.  You only need `configure.in' if you want to change
 105 it or regenerate `configure' using a newer version of `autoconf'.
 106
 107 The simplest way to compile this package is:
 108
 109   1. `cd' to the directory containing the package's source code and type
 110      `./configure' to configure the package for your system.  If you're
 111      using `csh' on an old version of System V, you might need to type
 112      `sh ./configure' instead to prevent `csh' from trying to execute
 113      `configure' itself.
 114
 115      Running `configure' takes awhile.  While running, it prints some
 116      messages telling which features it is checking for.
 117
 118   2. Type `make' to compile the package.
 119
 120   3. Optionally, type `make check' to run any self-tests that come with
 121      the package.
 122
 123   4. Type `make install' to install the programs and any data files and
 124      documentation.
 125
 126   5. You can remove the program binaries and object files from the
 127      source code directory by typing `make clean'.  To also remove the
 128      files that `configure' created (so you can compile the package for
 129      a different kind of computer), type `make distclean'.  There is
 130      also a `make maintainer-clean' target, but that is intended mainly
 131      for the package's developers.  If you use it, you may have to get
 132      all sorts of other programs in order to regenerate files that came
 133      with the distribution.
 134
 135 Compilers and Options
 136 =====================
 137
 138    Some systems require unusual options for compilation or linking that
 139 the `configure' script does not know about.  You can give `configure'
 140 initial values for variables by setting them in the environment.  Using
 141 a Bourne-compatible shell, you can do that on the command line like
 142 this:
 143      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 144
 145 Or on systems that have the `env' program, you can do it like this:
 146      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 147
 148 Compiling For Multiple Architectures
 149 ====================================
 150
 151    You can compile the package for more than one kind of computer at the
 152 same time, by placing the object files for each architecture in their
 153 own directory.  To do this, you must use a version of `make' that
 154 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 155 directory where you want the object files and executables to go and run
 156 the `configure' script.  `configure' automatically checks for the
 157 source code in the directory that `configure' is in and in `..'.
 158
 159    If you have to use a `make' that does not supports the `VPATH'
 160 variable, you have to compile the package for one architecture at a time
 161 in the source code directory.  After you have installed the package for
 162 one architecture, use `make distclean' before reconfiguring for another
 163 architecture.
 164
 165 Installation Names
 166 ==================
 167
 168    By default, `make install' will install the package's files in
 169 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 170 installation prefix other than `/usr/local' by giving `configure' the
 171 option `--prefix=PATH'.
 172
 173    You can specify separate installation prefixes for
 174 architecture-specific files and architecture-independent files.  If you
 175 give `configure' the option `--exec-prefix=PATH', the package will use
 176 PATH as the prefix for installing programs and libraries.
 177 Documentation and other data files will still use the regular prefix.
 178
 179    In addition, if you use an unusual directory layout you can give
 180 options like `--bindir=PATH' to specify different values for particular
 181 kinds of files.  Run `configure --help' for a list of the directories
 182 you can set and what kinds of files go in them.
 183
 184    If the package supports it, you can cause programs to be installed
 185 with an extra prefix or suffix on their names by giving `configure' the
 186 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 187
 188 Optional Features
 189 =================
 190
 191    Some packages pay attention to `--enable-FEATURE' options to
 192 `configure', where FEATURE indicates an optional part of the package.
 193 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 194 is something like `gnu-as' or `x' (for the X Window System).  The
 195 `README' should mention any `--enable-' and `--with-' options that the
 196 package recognizes.
 197
 198    For packages that use the X Window System, `configure' can usually
 199 find the X include and library files automatically, but if it doesn't,
 200 you can use the `configure' options `--x-includes=DIR' and
 201 `--x-libraries=DIR' to specify their locations.
 202
 203 Specifying the System Type
 204 ==========================
 205
 206    There may be some features `configure' can not figure out
 207 automatically, but needs to determine by the type of host the package
 208 will run on.  Usually `configure' can figure that out, but if it prints
 209 a message saying it can not guess the host type, give it the
 210 `--host=TYPE' option.  TYPE can either be a short name for the system
 211 type, such as `sun4', or a canonical name with three fields:
 212      CPU-COMPANY-SYSTEM
 213
 214 See the file `config.sub' for the possible values of each field.  If
 215 `config.sub' isn't included in this package, then this package doesn't
 216 need to know the host type.
 217
 218    If you are building compiler tools for cross-compiling, you can also
 219 use the `--target=TYPE' option to select the type of system they will
 220 produce code for and the `--build=TYPE' option to select the type of
 221 system on which you are compiling the package.
 222
 223 Sharing Defaults
 224 ================
 225
 226    If you want to set default values for `configure' scripts to share,
 227 you can create a site shell script called `config.site' that gives
 228 default values for variables like `CC', `cache_file', and `prefix'.
 229 `configure' looks for `PREFIX/share/config.site' if it exists, then
 230 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 231 `CONFIG_SITE' environment variable to the location of the site script.
 232 A warning: not all `configure' scripts look for a site script.
 233
 234 Operation Controls
 235 ==================
 236
 237    `configure' recognizes the following options to control how it
 238 operates.
 239
 240 `--cache-file=FILE'
 241      Use and save the results of the tests in FILE instead of
 242      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 243      debugging `configure'.
 244
 245 `--help'
 246      Print a summary of the options to `configure', and exit.
 247
 248 `--quiet'
 249 `--silent'
 250 `-q'
 251      Do not print messages saying which checks are being made.  To
 252      suppress all normal output, redirect it to `/dev/null' (any error
 253      messages will still be shown).
 254
 255 `--srcdir=DIR'
 256      Look for the package's source code in directory DIR.  Usually
 257      `configure' can determine that directory automatically.
 258
 259 `--version'
 260      Print the version of Autoconf used to generate the `configure'
 261      script, and exit.
 262
 263 `configure' also accepts some other, not widely useful, options.