Subversion Repositories svnkaklik

Rev

Rev 437 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log

Rev 437 Rev 483
Line 1... Line 1...
1 
Basic Installation
 1 
Installation and setup notes for sidd-0.93, 15th March 2005.
2 
==================
 2 
------------------------------------------------------------
3 
 
 3 
 
4 
   These are generic installation instructions.
 - 
 
5 
 
 - 
 
6 
   The `configure' shell script attempts to guess correct values for
 - 
 
7 
various system-dependent variables used during compilation.  It uses
 - 
 
8 
those values to create a `Makefile' in each directory of the package.
 - 
 
9 
It may also create one or more `.h' files containing system-dependent
 - 
 
10 
definitions.  Finally, it creates a shell script `config.status' that
 - 
 
11 
you can run in the future to recreate the current configuration, a file
 - 
 
12 
`config.cache' that saves the results of its tests to speed up
 - 
 
13 
reconfiguring, and a file `config.log' containing compiler output
 - 
 
14 
(useful mainly for debugging `configure').
 - 
 
15 
 
 - 
 
16 
   If you need to do unusual things to compile the package, please try
 - 
 
17 
to figure out how `configure' could check whether to do them, and mail
 - 
 
18 
diffs or instructions to the address given in the `README' so they can
 - 
 
19 
be considered for the next release.  If at some point `config.cache'
 - 
 
20 
contains results you don't want to keep, you may remove or edit it.
 - 
 
21 
 
 - 
 
22 
   The file `configure.in' is used to create `configure' by a program
 - 
 
23 
called `autoconf'.  You only need `configure.in' if you want to change
 - 
 
24 
it or regenerate `configure' using a newer version of `autoconf'.
 - 
 
25 
 
 - 
 
26 
The simplest way to compile this package is:
 - 
 
27 
 
 - 
 
28 
  1. `cd' to the directory containing the package's source code and type
 - 
 
29 
     `./configure' to configure the package for your system.  If you're
 - 
 
30 
     using `csh' on an old version of System V, you might need to type
 - 
 
31 
     `sh ./configure' instead to prevent `csh' from trying to execute
 - 
 
32 
     `configure' itself.
 - 
 
33 
 
 - 
 
34 
     Running `configure' takes a while.  While running, it prints some
 - 
 
35 
     messages telling which features it is checking for.
 - 
 
36 
 
 - 
 
37 
  2. Type `make' to compile the package.
 - 
 
38 
 
 - 
 
39 
  3. Type `make install' to install the programs and any data files and
 - 
 
40 
     documentation.
 - 
 
41 
 
 - 
 
42 
  4. You can remove the program binaries and object files from the
 4 
You have unpacked the tgz file and have 3 files:-
43 
     source code directory by typing `make clean'.
- 
 
44 
 
 - 
 
45 
Compilers and Options
 - 
 
46 
=====================
 - 
 
47 
 
 - 
 
48 
   Some systems require unusual options for compilation or linking that
 - 
 
49 
the `configure' script does not know about.  You can give `configure'
 - 
 
50 
initial values for variables by setting them in the environment.  Using
 - 
 
51 
a Bourne-compatible shell, you can do that on the command line like
 - 
 
52 
this:
 - 
 
53 
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 - 
 
54 
 
 - 
 
55 
Or on systems that have the `env' program, you can do it like this:
 - 
 
56 
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 - 
 
57 
 
 - 
 
58 
Compiling For Multiple Architectures
 - 
 
59 
====================================
 - 
 
60 
 
 - 
 
61 
   You can compile the package for more than one kind of computer at the
 - 
 
62 
same time, by placing the object files for each architecture in their
 - 
 
63 
own directory.  To do this, you must use a version of `make' that
 - 
 
64 
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 - 
 
65 
directory where you want the object files and executables to go and run
 - 
 
66 
the `configure' script.  `configure' automatically checks for the
 - 
 
67 
source code in the directory that `configure' is in and in `..'.
 - 
 
68 
 
 - 
 
69 
   If you have to use a `make' that does not supports the `VPATH'
 - 
 
70 
variable, you have to compile the package for one architecture at a time
 - 
 
71 
in the source code directory.  After you have installed the package for
 - 
 
72 
one architecture, use `make distclean' before reconfiguring for another
 - 
 
73 
architecture.
 - 
 
74 
 
 - 
 
75 
Installation Names
 - 
 
76 
==================
 - 
 
77 
 
 - 
 
78 
   By default, `make install' will install the package's files in
 - 
 
79 
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
 - 
 
80 
installation prefix other than `/usr/local' by giving `configure' the
 - 
 
81 
option `--prefix=PATH'.
 - 
 
82 
 
 - 
 
83 
   You can specify separate installation prefixes for
 - 
 
84 
architecture-specific files and architecture-independent files.  If you
 - 
 
85 
give `configure' the option `--exec-prefix=PATH', the package will use
 - 
 
86 
PATH as the prefix for installing programs and libraries.
 - 
 
87 
Documentation and other data files will still use the regular prefix.
 - 
 
88 
 
 - 
 
89 
   If the package supports it, you can cause programs to be installed
 - 
 
90 
with an extra prefix or suffix on their names by giving `configure' the
 - 
 
91 
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 - 
 
92 
 
 - 
 
93 
Optional Features
 - 
 
94 
=================
 - 
 
95 
 
 - 
 
96 
   Some packages pay attention to `--enable-FEATURE' options to
 - 
 
97 
`configure', where FEATURE indicates an optional part of the package.
 - 
 
98 
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 - 
 
99 
is something like `gnu-as' or `x' (for the X Window System).  The
 - 
 
100 
`README' should mention any `--enable-' and `--with-' options that the
 - 
 
101 
package recognizes.
 - 
 
102 
 
 - 
 
103 
   For packages that use the X Window System, `configure' can usually
 - 
 
104 
find the X include and library files automatically, but if it doesn't,
 - 
 
105 
you can use the `configure' options `--x-includes=DIR' and
 - 
 
106 
`--x-libraries=DIR' to specify their locations.
 - 
 
107 
 
 - 
 
108 
Specifying the System Type
 - 
 
109 
==========================
 - 
 
110 
 
 - 
 
111 
   There may be some features `configure' can not figure out
 - 
 
112 
automatically, but needs to determine by the type of host the package
 - 
 
113 
will run on.  Usually `configure' can figure that out, but if it prints
 - 
 
114 
a message saying it can not guess the host type, give it the
 - 
 
115 
`--host=TYPE' option.  TYPE can either be a short name for the system
 - 
 
116 
type, such as `sun4', or a canonical name with three fields:
 - 
 
117 
     CPU-COMPANY-SYSTEM
 - 
 
118 
 
 - 
 
119 
See the file `config.sub' for the possible values of each field.  If
 - 
 
120 
`config.sub' isn't included in this package, then this package doesn't
 - 
 
121 
need to know the host type.
 - 
 
122 
 
 - 
 
123 
   If you are building compiler tools for cross-compiling, you can also
 - 
 
124 
use the `--target=TYPE' option to select the type of system they will
 - 
 
125 
produce code for and the `--build=TYPE' option to select the type of
 - 
 
126 
system on which you are compiling the package.
 - 
 
127 
 
 - 
 
128 
Sharing Defaults
 - 
 
129 
================
 - 
 
130 
 
 - 
 
131 
   If you want to set default values for `configure' scripts to share,
 - 
 
132 
you can create a site shell script called `config.site' that gives
 - 
 
133 
default values for variables like `CC', `cache_file', and `prefix'.
 - 
 
134 
`configure' looks for `PREFIX/share/config.site' if it exists, then
 - 
 
135 
`PREFIX/etc/config.site' if it exists.  Or, you can set the
 - 
 
136 
`CONFIG_SITE' environment variable to the location of the site script.
 - 
 
137 
A warning: not all `configure' scripts look for a site script.
 - 
 
138 
 
 - 
 
139 
Operation Controls
 - 
 
140 
==================
 - 
 
141 
 
 - 
 
142 
   `configure' recognizes the following options to control how it
 - 
 
143 
operates.
 - 
 
144 
 
 - 
 
145 
`--cache-file=FILE'
 - 
 
146 
     Use and save the results of the tests in FILE instead of
 - 
 
147 
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 - 
 
148 
     debugging `configure'.
 - 
 
149 
 
 - 
 
150 
`--help'
 - 
 
151 
     Print a summary of the options to `configure', and exit.
 - 
 
152 
 
 - 
 
153 
`--quiet'
 - 
 
154 
`--silent'
 - 
 
155 
`-q'
 - 
 
156 
     Do not print messages saying which checks are being made.
 - 
 
157 
 
 - 
 
158 
`--srcdir=DIR'
 - 
 
159 
     Look for the package's source code in directory DIR.  Usually
 - 
 
160 
     `configure' can determine that directory automatically.
 - 
 
161 
 
 - 
 
162 
`--version'
 - 
 
163 
     Print the version of Autoconf used to generate the `configure'
 - 
 
164 
     script, and exit.
 - 
 
165 
 
 - 
 
166 
`configure' also accepts some other, not widely useful, options.
 - 
 
167 
 
 5 
 
- 
 
 6 
 * README - this one
- 
 
 7 
 * sidd.c - source code
- 
 
 8 
 * sidd.conf - a sample configuration file.
- 
 
 9 
 
- 
 
 10 
Installation steps
- 
 
 11 
------------------
- 
 
 12 
* 1/
- 
 
 13 
You will need FFTW3 from www.fftw.org, if not already installed.
- 
 
 14 
 
- 
 
 15 
* 2/
- 
 
 16 
Compile the sidd source with
- 
 
 17 
 
- 
 
 18 
 gcc -Wall -O4 -ffast-math -DPENTIUM -Wall -o sidd sidd.c -lfftw3 -lm
- 
 
 19 
 
- 
 
 20 
which produces an executable sidd in the current directory.
- 
 
 21 
 
- 
 
 22 
* 3/
- 
 
 23 
Edit sidd.conf to suit your requirements.
- 
 
 24 
 
- 
 
 25 
* 4/
- 
 
 26 
Start sidd in verbose foreground mode with the command
- 
 
 27 
 
- 
 
 28 
 ./sidd -vf
- 
 
 29 
 
- 
 
 30 
* 5/
- 
 
 31 
Examine the log file - it should look something like
- 
 
 32 
 
- 
 
 33 
 2005/03/15 20:03:17 logfile /root/sidd.log
- 
 
 34 
 2005/03/15 20:03:17 los threshold 0.060, timeout 5 seconds
- 
 
 35 
 2005/03/15 20:03:17 band LB 18200 18400
- 
 
 36 
 2005/03/15 20:03:17 band AN 19480 19680
- 
 
 37 
 2005/03/15 20:03:17 band SK 22050 22150
- 
 
 38 
 2005/03/15 20:03:17 band BG 23300 23500
- 
 
 39 
 2005/03/15 20:03:17 band TV 20190 20340
- 
 
 40 
 2005/03/15 20:03:17 band NV 16300 16500
- 
 
 41 
 2005/03/15 20:03:17 band B1 20800 21000
- 
 
 42 
 2005/03/15 20:03:17 band B2 22650 22850
- 
 
 43 
 2005/03/15 20:03:17 requesting line input gains left=77 right=100
- 
 
 44 
 2005/03/15 20:03:17 line input gains set to: left=77 right=100
- 
 
 45 
 2005/03/15 20:03:17 taking data from [/dev/dsp]
- 
 
 46 
 2005/03/15 20:03:17 requesting rate 48000
- 
 
 47 
 2005/03/15 20:03:17 actual rate set: 48662 samples/sec
- 
 
 48 
 2005/03/15 20:03:17 soundcard channels: 1  bits: 16
- 
 
 49 
 2005/03/15 20:03:17 resolution: bins=2048 fftwid=4096 df=11.880371
- 
 
 50 
 2005/03/15 20:03:17 spectrum file: /tmp/sidspec
- 
 
 51 
 2005/03/15 20:03:17 using SCHED_FIFO priority 1
- 
 
 52 
 2005/03/15 20:03:17 sidd version 0.93: starting work
- 
 
 53 
 2005/03/15 20:03:17 using output file [./050315.dat]
- 
 
 54 
 
- 
 
 55 
* 6/
- 
 
 56 
Now tail the output file (in my example, ./050315.dat).  The first
- 
 
 57 
three columns are the timestamp (seconds from 01/01/1970), peak signal
- 
 
 58 
level (range 0 to 1), and rms signal level (also range 0 to 1).
- 
 
 59 
 
- 
 
 60 
Adjust your mixer gain settings so that the peak hovers around the
- 
 
 61 
range 0.1 to 0.5 (the rms will be around 1/2 or 1/3 of the peak, depending
- 
 
 62 
on your level of impulsive noise and sferics).
- 
 
 63 
 
- 
 
 64 
* 7/
- 
 
 65 
Plot the spectrum file, in my case /tmp/sidspec. This file is two columns,
- 
 
 66 
bin centre frequency in Hz, and relative power.  The file is re-written by
- 
 
 67 
sidd every 10 seconds or so, depending on your sidd.conf settings.  Adjust
- 
 
 68 
antennas, receivers, etc to obtain desired signal to noise ratios.  You
- 
 
 69 
may want to reconsider the band settings in sidd.conf at this point too.
- 
 
 70 
 
- 
 
 71 
* 8/
- 
 
 72 
Once you're happy with the gain settings, stop sidd and run it again with
- 
 
 73 
the command
- 
 
 74 
 
- 
 
 75 
 ./sidd -m
- 
 
 76 
 
- 
 
 77 
This will read and display the applicable mixer gain settings.  Now edit
- 
 
 78 
your sidd.conf, commenting in the gain commands and putting in your gain
- 
 
 79 
settings.   Then, whenever sidd starts, it will setup the mixer with these
- 
 
 80 
settings.  All mixers will have a line input gain control, but only some
- 
 
 81 
will have an overall input gain control and/or a record level control.
- 
 
 82 
The -m option will report what you need to put in the config file.
- 
 
 83 
 
- 
 
 84 
* 9/
- 
 
 85 
Set your PC clock and activate your favourite time synchronisation
- 
 
 86 
software.  Make sure it slews the clock rather than stepping the time.
- 
 
 87 
 
- 
 
 88 
* 10/
- 
 
 89 
Restart sidd in background with
- 
 
 90 
 
- 
 
 91 
  ./sidd -v
- 
 
 92 
 
- 
 
 93 
Inspect the log file to make sure your mixer settings have been applied.
- 
 
 94 
 
- 
 
 95 
* 11/
- 
 
 96 
After a period of time, plot some of the data from the output file.
- 
 
 97 
Output file columns 4 onwards correspond to the 'band' commands in the
- 
 
 98 
order they appear in sidd.conf.   Each column is a total relative power,
- 
 
 99 
so you will need to apply a square root function during plotting if you
- 
 
 100 
want to display relative amplitudes.
- 
 
 101 
 
- 
 
 102 
* 12/
- 
 
 103 
After a midnight crossing, make sure sidd has switched to the next
- 
 
 104 
output file.
- 
 
 105 
 
- 
 
 106 
Command line options
- 
 
 107 
--------------------
- 
 
 108 
There are just a few command line options - most controls are
- 
 
 109 
in the config file.
- 
 
 110 
 
- 
 
 111 
 -v    Be a little more verbose with log messages.
- 
 
 112 
 -f    Run in foreground.  By default, sidd detaches from the process
- 
 
 113 
       group and terminal and becomes a daemon.  In foreground mode,
- 
 
 114 
       log messages are duplicated to stderr.
- 
 
 115 
 -m    Interrogate the soundcard mixer and report settings, then exit.
- 
 
 116 
       This option overrides any others.
- 
 
 117 
 
- 
 
 118 
Miscellaneous notes
- 
 
 119 
-------------------
- 
 
 120 
*
- 
 
 121 
sidd will set the soundcard to the nearest available sample rate to that
- 
 
 122 
specified in sidd.conf
- 
 
 123 
 
- 
 
 124 
*
- 
 
 125 
Make sure you have enough disk space.   The example sidd.conf with 8 bands
- 
 
 126 
generates files of about 100Mbytes per day, which compress down to about
- 
 
 127 
30Mbytes.    Arrange scripts for plotting.  Arrange scripts for compressing
- 
 
 128 
and archiving files that are a few days old.
- 
 
 129 
 
- 
 
 130 
*
- 
 
 131 
You can specify an ordinary file or a pipe as the input 'device' instead
- 
 
 132 
of /dev/dsp.  In this case, you must set the sample rate in sidd.conf
- 
 
 133 
to whatever the actual sample rate is.  sidd is looking for unsigned bytes
- 
 
 134 
in 8 bit mode, or signed words in 16 bit mode.
- 
 
 135 
 
- 
 
 136 
*
- 
 
 137 
Once sidd has started up and set the mixer gains, it no longer takes any
- 
 
 138 
notice of the mixer.  Therefore once sidd is running, a rogue user can
- 
 
 139 
mess things up by twiddling the mixer settings with Xmixer or some other
- 
 
 140 
utility.  Kill off any mixer control panels to avoid the risk of any upset.
- 
 
 141 
 
- 
 
 142 
*
- 
 
 143 
If your PC is set to autoboot after a power outage, you might want to put
- 
 
 144 
a startup command for sidd into /etc/rc.d/rc.local or similar - but make
- 
 
 145 
sure the RTC setting commands are done first.