home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 September / PCWorld_2000-09_cd.bin / Software / TemaCD / SciLab / README < prev    next >
Text File  |  2000-07-21  |  16KB  |  364 lines
  1.               Scilab version 2.5
  2.                            ********************
  3.  
  4.  ******************************************************************************
  5.                    INSTALLATION GUIDE
  6.  ******************************************************************************
  7.  
  8.  0 - COPYRIGHT NOTICE
  9.  ********************
  10.  
  11.  Scilab is free software. It can be used both in academia and in industry
  12.  free of charge.
  13.  
  14.  To use Scilab, you need to fill and return the end of the file notice.tex 
  15.  or notice.ps (postscript file). You may email to Scilab@inria.fr.
  16.  
  17.  ******************************************************************************
  18.  
  19.  In the following, all the paths are relative to the Scilab directory 
  20.  (scilab-2.5 directory).
  21.  
  22.  I - TO INSTALL SCILAB
  23.  *********************
  24.  
  25.   A - IF YOU HAVE A COMPILED VERSION
  26.   ----------------------------------
  27.     Simply do, in Scilab directory:
  28.      make
  29.    
  30.   B - IF YOU HAVE A SOURCE VERSION
  31.   --------------------------------
  32.     This distribution has been tested on the following machines:
  33.     HP9000, SUN Sparcstation (Sun OS and Solaris 5.*), IBM RS6000, 
  34.     DEC alpha OSF, Dec alpha Linux, SGI, PC linux (a.out and ELF) and
  35.     Mac Mklinux.
  36.  
  37.     You need X Window (X11R4, X11R5 or X11R6), Athena Widgets libraries, 
  38.     C compiler and fortran compiler.
  39.  
  40.     1 - Configure your system by issuing the following command in the Scilab 
  41.         directory:
  42.      ./configure --with-tk
  43.     Or simply "./configure" if you don't have tcl/tk 8.0 or later installed.
  44.  
  45.         This will create and/or modify a few Makefile and other files for your 
  46.         system.
  47.         You can give options to configure command, see below.
  48.  
  49.     2 - Do in the Scilab directory:
  50.      make all
  51.  
  52.         This will compile Scilab and set everything.
  53.  
  54.     Configure options:
  55.     ------------------
  56.      --enable-debug: compile with "-g" option and do not optimize
  57.  
  58.      --with-gcc: use gcc C compiler (note that the compilation options
  59.            have not been tested on all machines, see C below)
  60.  
  61.      --with-g77: use g77 fortran compiler (note that the compilations
  62.            options have not been tested on all machines, see C below)
  63.  
  64.      --with-gnu: use gcc C compiler and g77 fortran compiler (note that 
  65.            the compilation options have not been tested on all machines, 
  66.            see C below)
  67.  
  68.          --x-libraries=DIR: X Window library files are in DIR
  69.          --x-includes=DIR: X Window include files are in DIR
  70.  
  71.      --with-local-Xaw: compile and use Athena Widgets libraries given 
  72.            with Scilab (do not use then for X11R4); configure chooses local
  73.            Athena Widgets library when needed, so the use of this option is not
  74.            recommanded (see below KNOWN PROBLEMS 3).
  75.  
  76.          --without-pvm: compile without PVM library. The default is to compile
  77.            with PVM library.
  78.  
  79.          --with-tk: compile with TCL/TK library. The default is to compile
  80.            without TCL/TK library. You must have libraries of TCL/TK 8.x and 
  81.            corresponding include files installed in standard directory 
  82.            (configure is looking for them).
  83.            If your libraries and include files are in customized places, 
  84.            you can specify them by hand with the following arguments:
  85.                 -with-tcl-library=TCL_LIB_DIR: Tcl library is in TCL_LIB_DIR
  86.                 -with-tcl-include=TCL_INC_DIR: Tcl include is in TCL_INC_DIR
  87.                 -with-tk-library=TK_LIB_DIR: Tk library is in TK_LIB_DIR
  88.                 -with-tk-include=TK_INC_DIR: Tk include is in TK_INC_DIR
  89.  
  90.   C - CHANGING THE COMPILATION OPTIONS (source version only)
  91.   ------------------------------------
  92.      You may want to change the options used to compile Scilab, names of the
  93.      compilers, compilation options, linker options, and so on; you can easily 
  94.      do that.
  95.  
  96.      The main "Makefile" of Scilab includes "Makefile.incl" and
  97.      "config/Makefile.<machine>":
  98.        "Makefile.incl" contains all the compilation options
  99.        "config/Makefile.<machine>" is only used for the link of the executable 
  100.            "scilex" of Scilab.
  101.  
  102.     The file "Makefile.incl" is included by all the Makefiles of the 
  103.     distribution, so it is THE place where you can change compilation 
  104.     options (it is self documented).
  105.  
  106.     Note that "Makefile.incl" is automatically generated by "configure"
  107.     from "Makefile.incl.in", so your modifications of "Makefile.incl" are
  108.     discarded every time you run "configure". 
  109.     Users knowing the way "configure" works may want to modify directly the 
  110.     "configure" file.
  111.     Even more, users knowing the way "autoconf" works may want to modify 
  112.     the "configure.in" file and then run "autoconf" (version 2.12) to generate
  113.     the "configure" file.
  114.  
  115.   D - CUSTOMIZING YOUR SCILAB
  116.   ---------------------------
  117.     1 - If you want to recompile Scilab after modifications, execute only 
  118.         the "make all" command in Scilab directory (source version only).
  119.  
  120.         If you want to clean all executable, object files and libraries 
  121.         and then recompile Scilab, execute the following commands
  122.         (source version only):
  123.      make distclean
  124.      make all
  125.  
  126.     2 - To print your postscript figures, the list of printers is defined
  127.         in the environment variable "PRINTERS" or in the beginning of 
  128.         the shell script "bin/scilab".
  129.  
  130.     3 - Note that the functions "macros/util/edit" and
  131.         "macros/util/manedit" assume that your default editor 
  132.         is emacs. You may change this in the corresponding function (or 
  133.         explicitly specify your editor when you invoke these functions).
  134.  
  135.     4 - Icons for windows managers: icons for Scilab, Scilab graphics windows
  136.         and Metanet graphics windows are given in the X11_defaults
  137.         subdirectory. See the README in this subdirectory.
  138.  
  139.     5 - COLOR RESOURCES: if you want to change the colors of your 
  140.         customization you need to modify the files in the X11_defaults
  141.         subdirectory (essentially the Xscilab file) or to copy the same
  142.         color resources in your personal resource file (home directory).
  143.  
  144.  ******************************************************************************
  145.  II - KNOWN PROBLEMS AND REMARKS
  146.  *******************************
  147.     0 - Note that C routines are not ANSI.
  148.  
  149.     1 - If there is something wrong when you open the scilab window 
  150.         check your ".Xdefault" file.
  151.  
  152.     2 - The fortran compiler version 1.3.1 of SUN Sparcstations has a bug:
  153.         reading or writing (with implicit loop) arrays  bigger than 4096 
  154.         elements does not work. This may cause Scilab to abort.
  155.         The solution is to upgrade your fortran compiler, for instance get 
  156.         version 1.4 (or use version 1.3.1 with object file "recio.o" from 
  157.         newer version).
  158.  
  159.     3 - Athena Widgets libraries libXaw.a and libXmu.a (and corresponding 
  160.         include files) are not systematically provided in some X11 
  161.         installations. If you are using X11R5 or X11R6, these libraries are 
  162.         provided for convenience with Scilab.
  163.         "configure" first tries to find existing Athena Widgets libraries.
  164.         If none are found and X Window release is not X11R4, it uses
  165.         local Athena Widgets libraries. Otherwise an error is issued.
  166.         You can impose the use of local Athena Widgets libraries by using
  167.         the option "--with-local-Xaw" with "configure".
  168.  
  169.         On some IBM RS6000 there exists a compatibility problem between the
  170.         X11-Mit distribution and the IBM version. If your system runs the IBM
  171.         X11 release you must use the IBM libXaw.a and libXmu.a libraries.
  172.  
  173.     4 - For DEC ALPHA workstation you must use the 3.4 or newer version
  174.         of the fortran compiler (the 3.3 version aborts on floating
  175.         point exceptions). You are encouraged to use the OSF 3.0 system
  176.         release and the fortran 3.5 release (the incremental link works
  177.         fine as well as all the floating point exceptions).
  178.  
  179.     5 - For HP workstation, programs to be incrementally linked should
  180.         be compiled with the option "+z" or "+Z".
  181.  
  182.     6 - With some Linux egcs compilers, compiling the three files
  183.         "comqr3.f" "dsvdc.f" and "wsvdc.f" (directory "routines/control")
  184.         with optimization can cause failure when computing some SVD. 
  185.         If not sure, compile them without optimization.
  186.  
  187.     7 - Scilab's tcl/tk interface does not work properly on Linux. 
  188.     To make it work, you should define the environment variables as follows 
  189.     (assuming you are using tcsh) 
  190.     setenv TCL_LIBRARY /usr/lib/tcl8.0 
  191.     setenv TK_LIBRARY /usr/lib/tk8.0 
  192.     Or to the appropriate directories if your tcl-tk is not installed in usual place.
  193.  
  194.  
  195.  
  196.     8 - Scilab ignores the last line of script and function files, if it is not ended 
  197.     with a carriage return. Most editors do that automatically on Unix. Emacs
  198.     does not do it by default. You can force it to do it by inserting the following 
  199.     line into your .emacs file 
  200.     (setq require-final-newline t) 
  201.  
  202.     9 - If when doing getf of a function you get the error message: 
  203.     error    26 too complex recursion! (recursion tables are full) 
  204.     and you cannot find anything wrong in the function. The problem 
  205.     may be that a body of a conditional statement or a loop is too big. 
  206.     For example if you have an if-then-end statement in which the number 
  207.     of characters between if and end is larger than 16000 you will have 
  208.     this problem. In that case you should reduce the size making functions. 
  209.  
  210.     10 - For x=[10e+20, 1.d-20] the display is:  x  = !   1.000E+21    0. ! 
  211.     Is the second entry really set to zero? 
  212.     No. This is a display feature. Entries which are proportionally 
  213.     insignificant are displayed as zero in a matrix. The proportional 
  214.     factor used is 1/%eps. To avoid this feature, use format('e'). 
  215.  
  216.     11 - The intruction 1./[1,2,3] is not the same as a=1;a./[1,2,3] ? 
  217.     The reason is that 1. is interpreted as 1 before the operation /. So,  
  218.     1./[1,2,3] is the same as 1/[1,2,3] i.e.a right inverse of [1,2,3].  
  219.     If you want to perform an element wise division use the a=1;a./[1,2,3] or
  220.     (1)./[1,2,3]. 
  221.  
  222.     12 - 1/0 returns  !--error    27 division by zero...  Why not Inf? 
  223.     You can do this by putting Scilab in IEEE mode. Use the instruction 
  224.     ieee(1) or ieee(2) depending on whether or not you want to see a 
  225.     warning in such situations. Use ieee(0) to get back to default mode. 
  226.  
  227.     14 - I run Scilab 2.4.1 on Windows 95 or 98 and I can't plot a vector longer than 2^14:
  228.          t=0:16383; plot(sin(t)) 
  229.     This bug seems to be due to the windows graphics library; they could be limited to 2^14.
  230.     We will try to modify the plot algorithm in the next version. 
  231.  
  232.     15 - An execution in a scilab script seems to stop in the middle of an instruction. 
  233.     One possibility is that you have an instruction line which is too long 
  234.     (more than 4000 characters). This may happen usually when defining a 
  235.     large matrix generated automatically. If you have a large matrix you 
  236.     should use the function read to load it into scilab. 
  237.  
  238.     16 - If you have any problem or suggestion to improve Scilab
  239.         send an email to:
  240.         
  241.                            Scilab@inria.fr
  242.  
  243.         or better post a message to newsgroup:
  244.  
  245.                comp.soft-sys.math.scilab
  246.  
  247.  ******************************************************************************
  248.  III - TO RUN SCILAB
  249.  *******************
  250.  
  251.  Run Scilab by executing "scilab" (shell script in bin).
  252.  
  253.  If the name of the directory of Scilab distribution is not the same on 
  254.  your machine than on the machine where Scilab was installed, define the
  255.  environment variable SCI to point to the directory of Scilab distribution.
  256.  In a sh like shell, do:
  257.   SCI=<name of the directory>
  258.   export SCI
  259.  In a csh like shell, do:
  260.   setenv SCI <name of the directory>
  261.  
  262.  ******************************************************************************
  263.  IV - DOCUMENTATION
  264.  ****************** 
  265.  
  266.  In addition to Scilab online documentation (obtained by typing "help item" or
  267.  "apropos keyword" or clicking on the help button), you will find 
  268.  compressed postscript and pdf documentation by anonymous ftp on
  269.  "ftp.inria.fr:/INRIA/Projects/Meta2/Scilab/doc" (internet# 192.93.2.54)
  270.  or from Web site
  271.  "http://www-rocq.inria.fr/scilab":
  272.  
  273.  Comm.ps.gz, Comm.pdf: Communication Toolbox
  274.  Internals.ps.gz, Internals.pdf: Scilab's internals
  275.  Intro.ps.gz, Intro.pdf: Introduction to Scilab
  276.  Lmi.ps.gz, Lmi.pdf: Linear Matrix Inequalities Optimization Toolbox
  277.  Manual.ps.gz, Manual.pdf: On line Manual
  278.  Metanet.ps.gz, Metanet.pdf: Metanet User's Guide and Tutorial
  279.  Scicos.ps.gz, Scicos.pdf: Scicos: a Dynamic System Builder and Simulator 
  280.  Signal.ps.gz, Signal.pdf: Signal Processing Toolbox
  281.  
  282.  ******************************************************************************
  283.  V - SOME IMPORTANT FILES AND DIRECTORIES
  284.  ****************************************
  285.  
  286.  scilab.star: startup file for Scilab: instructions in this file
  287.               are executed when Scilab is executed. Note that
  288.               you can also have your own startup file ".scilab"
  289.               in your current directory.
  290.  
  291.  configure.in: file used by "autoconf 2.12" to generate "configure".
  292.  
  293.  configure: file used to configure Scilab.
  294.  
  295.  Makefile.incl.in: file used by configure to generate Makefile.incl.
  296.  
  297.  Makefile.incl: file included by all Makefile's. It is automatically 
  298.                 generated by configure.
  299.  
  300.  Path.incl: contains the scilab directory pathname. It is included by 
  301.             scripts/Makefile. This file is automatically generated by 
  302.             configure.
  303.  
  304.  Version.incl: contains the scilab version. It is used by a few Makefile.
  305.  
  306.  Makefile.in: file used by configure to generate Makefile.
  307.  
  308.  Makefile: the main Makefile to make Scilab. It is automatically generated by
  309.            configure.
  310.  
  311.  config/   : directory used by configure and by the main Makefile
  312.  
  313.                 Makefile.<host>: Makefile included by main Makefile. It depends
  314.                                  on the host and is used to created the 
  315.                                  executable bin/scilex.
  316.  
  317.  demos/    : demos directory. Some of the demos can be executed by clicking
  318.              on the "demos" button.
  319.  
  320.  examples/ : examples of dynamic links and interface code.
  321.  
  322.  macros/   : functions directory: this directory is divided into 
  323.              subdirectories corresponding to specific topics
  324.              (control, polynomials,...). Each subdirectory contains 
  325.              the source code of the macros (files *.sci). 
  326.  
  327.  xmetanet/ : XMetanet routines.
  328.  
  329.  geci/     : Geci (interprocess communication tool) routines.
  330.  
  331.  libs/      : directory of libraries: archives of object files needed 
  332.              to link Scilab.
  333.  
  334.  routines/ : directory of fortran or C routines. Divided into subdirectories
  335.              (see below).
  336.  
  337.  doc/      : directory of documentation. Usually LaTeX files.
  338.  
  339.  man/      : man files and LaTeX manual.
  340.  
  341.  tests/    : set of exec files to test Scilab.
  342.  
  343.  util/     : useful routines and ASCII files to manage Scilab.
  344.  
  345.  bin/      : executable code and scripts.
  346.          scilab  : shell-script to call Scilab and miscellaneous tools
  347.                            execute scilab -help scilab for help.
  348.          scilex  : executable code of Scilab.
  349.          scilink : shell script called by scilab -link.
  350.                  intersci: generator of interface program between Scilab and 
  351.                            routines.
  352.  
  353.  intersci/ : Generator of interface program between Scilab and routines.
  354.  
  355.  maple/    : Maple code to link Maple with Scilab.
  356.  
  357.  pvm3/      : PVM 3.4 beta 6 for Scilab.
  358.  
  359.  tcl/      : TCL/TK for Scilab.
  360.  
  361.  ******************************************************************************
  362.                     THAT'S ALL FOLKS
  363.  ******************************************************************************
  364.