git.gag.com Git - debian/splat/blob - README

   1     ======================================================================
   2     SPLAT!: A Terrestrial RF Path and Terrain Analysis Tool for Unix/Linux
   3     ======================================================================
   4
   5
   6 Requirements
   7 ============
   8 SPLAT! requires the libbzip2-1.0.1 (or later) compression library and
   9 header files for successful compilation.  bzip2/libbzip2 is available
  10 at: http://sources.redhat.com/bzip2/
  11
  12 SPLAT! also requires the zlib general purpose compression library.
  13 Any recent version included with your Linux distribution should work
  14 fine.  Note, however, that zlib version 1.1.3 contains a security
  15 vulnerability that has been fixed in version 1.1.4.  The latest
  16 version of zlib may be found at: http://www.gzip.org/zlib/
  17 If you should decide to build zlib, it is important to invoke:
  18
  19         ./configure -s
  20
  21 to build zlib as a shared library.
  22
  23 If you wish to plot terrain and elevation profiles through SPLAT!,
  24 you will need gnuplot.  The latest version of gnuplot is available
  25 at: http://www.gnuplot.info/ if you don't already have it.
  26
  27 You will also need an application for viewing large PPM graphics
  28 files generated by SPLAT!.  XV, ImageMagick, XPaint, and The GIMP
  29 all perform this task well (especially The GIMP).
  30
  31 It goes without saying that a C++ compiler (gcc/g++) and math libraries
  32 are also needed to build SPLAT!  SPLAT! is fully compatible with the
  33 latest versions of the GCC compiler.
  34
  35
  36 Installation Instructions
  37 =========================
  38 Unpack the tar.gz file in a source code directory (such as /usr/src
  39 under Slackware) as 'root':
  40
  41         cd /usr/src
  42         tar xvfz splat-1.3.0.tar.gz
  43
  44 This action will generate a subdirectory named splat-1.3.0.
  45
  46 Next, cd into the directory:
  47
  48         cd splat-1.3.0
  49
  50 Invoke the configure script to build SPLAT! and related utilities:
  51
  52         ./configure
  53
  54 If you are 'root', SPLAT! and its related man page and utilities will
  55 be installed after the compilation process is complete.  If not, you
  56 will be prompted to su to 'root' and invoke the install script manually:
  57
  58         su root
  59         Password:
  60         ./install all
  61         exit
  62
  63 Before running SPLAT!, carefully read the documentation located under
  64 the splat-1.3.0/docs directory for information on the use of the program.
  65 Some sample data files are located under the splat-1.3.0/sample_data
  66 directory.
  67
  68 REMEMBER: Topography data must be downloaded and SPLAT Data Files must
  69 be generated using the included srtm2sdf, postdownload, or usgs2sdf
  70 utilities before using SPLAT!  Instructions for doing so are included
  71 in the documentation.
  72
  73 It is a good practice to create a working directory for SPLAT! use
  74 under your home directory:
  75
  76         mkdir $HOME/splat-work
  77
  78 Then:
  79         cd $HOME/splat-work
  80
  81 before invoking SPLAT!
  82
  83 In this manner, all associated SPLAT! working files can be kept in a
  84 common directory.
  85
  86 It is important to realize that when analyzing regional coverage
  87 areas of transmitters, repeaters, or cell sites, SPLAT Data Files
  88 need to be available for the entire region surrounding the site(s)
  89 being analyzed.  SPLAT Data Files can be placed under your SPLAT!
  90 working directory, or under a separate directory specified in your
  91 $HOME/.splat_path file so SPLAT! can easily find them.
  92
  93 Please read the README file under the utils directory for information
  94 on the utilities included with SPLAT!.
  95
  96 Please read the documentation under the splat-1.3.0/docs directory,
  97 or consult the program's man page for more information and examples
  98 of SPLAT! use.
  99
 100 The latest announcements and information regarding SPLAT! software
 101 can be found on the SPLAT! Web Site:
 102
 103         http://www.qsl.net/kd2bd/splat.html
 104
 105 --
 106 John A. Magliacane, KD2BD
 107 August, 2008