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