Imported Upstream version 4.6.0
[debian/atlc] / README
1 atlc - Arbitrary Transmission Line Calculator.
2
3 Program for analysing arbitrary transmission lines and directional
4 couplers. See HTML documentation in docs/html-docs
5
6 *********************************************************************
7 IMPORTANT - if altc won't compile on your system, configure with the 
8 option --without-hardware-info. It should then compile. 
9 *********************************************************************
10
11 atlc is available as source code in a file atlc-version.tar.gz. Some
12 older binary releases are in existance but I would advise against 
13 using version of atlc prior to 4.6.0 for multiple dielectrics. 
14
15 See the file INSTALL if building from sources. Online documentation may
16 be found at http://atlc.sourceforge.net/
17
18 The sources are kept in src/non_gui, as a version with a GUI was
19 planned, but I don't think it will happen in the near future.
20
21 This is the directory layout. .
22 ./docs 
23 ./docs/html-docs         // As on the atlc web site at atlc.sourgeforge.net
24 ./docs/html-docs/jpgs    // JPGS needed for the html docs above.
25 ./docs/qex-december-1996 // A old paper I wrote, gives the theory.
26 ./docs/theory            //  
27 ./man                    // Standard UNIX man pages.
28 ./examples               // Some examples
29 ./tests                  // Self-tests and a benchmark.
30 ./tools                  // Some tools that are useful for checkign the code
31 ./tools/src              // Source code for above
32 ./src                    // Nothing much - see below
33 ./src/non_gui            // All the C source code.   
34 ./tmp                    // Used during tests to dump data. 
35
36 After building (see INSTALL, which I've modified to be specific to
37 atlc) you should run 'make check' after running 'make'. 
38 One built, if you want to install the examples and binaries, run
39 'make install'. As the examples are large (~220 Mb) you might    
40 choose not to install them. In which case run 'make install-exec'
41 rather than 'make install'. If you later want to install the 
42 examples, run 'make install-data'
43
44 If wishing to contact me by email, mail me on drkirkby at ntlworld.com
45
46 Dr. David Kirkby, G8WRB. 12th December 2003 Re: atlc-4.6.0