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