home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / general / fractal / kaos.lha / README.install < prev   
Encoding:
Text File  |  1990-01-22  |  5.5 KB  |  160 lines
  1.  
  2. ##########################################################################
  3. #
  4. #        INSTALLING KAOS
  5. #
  6. ##########################################################################
  7.     SETTING KAOS ENVIRONMENTAL VARIABLES
  8. #########################################################################
  9.  
  10.     In order to install and run "kaos", you need to insert a few lines
  11.     into the files ".login" and ".cshrc" in your home directory.
  12.  
  13. (1)    Include the environmental variable "KAOSHOME",
  14.     which is the top directory where kaos is currently installed.
  15.     (Ask the system manager or try to locate where the executable "kaos"
  16.     is in the system file hierarchy.)
  17.  
  18.     For example, insert a line such as
  19.  
  20.         setenv KAOSHOME ${HOME}/kaos
  21.  
  22. (2)    Add the directories, ${KAOSHOME} and ${KAOSHOME}/bin,
  23.     to the search path. This ensures that you can run the program
  24.     kaos and its companion programs in any directory and make
  25.     future installation work.
  26.     For example, a line in .login and .cshrc should look like
  27.  
  28.         set path = (${KAOSHOME} ${KAOSHOME}/bin other_directories...)
  29.  
  30. ########################################################################
  31.     USING KAOS_INSTALL
  32. ########################################################################
  33.  
  34.     Use the shell script "kaos_install"  to set various flags
  35.     such as the top directory, the operating system type, 
  36.     the printer name, the math flag, and the floating point coprocessor type
  37.  
  38.   (1)    Make sure first that ${KAOSHOME} environmental variable is set
  39.     as instructed in the previous section.
  40.  
  41.   (2)    Move to the directory ${KAOSHOME}.
  42.  
  43.   (3)    Type "kaos_install"     and follow the instructions on the screen.
  44.  
  45. # NOTE:    The existence of the file "installcap" is important. Do not edit
  46.     this file directly unless you are quite sure.
  47.     In case you edit the installcap file, make sure that information
  48.     in it is consistent with those in the files, Makefile, in various
  49.     kaos directories and in the kaos header files in the
  50.     directory ${KAOSHOME}/include.
  51.     
  52.  
  53. ##########################################################################
  54.     COMPILING AND LOADING KAOS WITH MAKEFILE
  55. ###########################################################################
  56.  
  57.     If you have not defined ${KAOSHOME} in ".login" and ".cshrc", do so now.
  58.     If you have not run "kaos_install", do so now.
  59.  
  60.   (1)    Note that a default directory for the user-customized kaos ("kaos_u") is
  61.     set to ${HOME}/kaos in "Makefile" in the directory ${KAOSHOME}.
  62.     If you want to install "kaos_u" in another directory, 
  63.     edit the variable KAOS_USER_DIR below.
  64.  
  65.   (2)    To make all the executables kaos needs, type
  66.     either "make all" if you are installing kaos from scratch
  67.     or "make all_u" if kaos is already installed on the system and you
  68.     want to make a local version of it with new dynamical systems.
  69.  
  70.     To make the main executable only, type
  71.     either "make kaos",
  72.     or "make kaos_u"
  73.  
  74.     To make a batch executable only, type
  75.     either "make kaos_batch"
  76.     or "make kaos_batch_u"
  77.     (This is necessary to send batch jobs.)
  78.  
  79.     To make all the rest of executables in ${KAOSHOME}/bin,
  80.     type "make bin"
  81.  
  82.  
  83. #######################################################################
  84.     INSTALLING A NEW DYNAMICAL SYSTEM
  85. #######################################################################
  86.     
  87.     Look up README file in the directory ${KAOSHOME}/userlib
  88.  
  89. ########################################################################
  90.     ACCESSING THE SOURCE CODE PF BUILT-IN DYNAMICAL SYSTEMS IN DATABASE
  91. ########################################################################
  92.  
  93.     Lookup README file in ${KAOSHOME}/modellib directory for more
  94.     information on how many vector fields and maps in our
  95.     dynamical system database are defined.
  96.  
  97. ########################################################################
  98.     DESCRIPTION OF BUILT-IN DYNAMICAL SYSTEMS IN DATABASE
  99. ########################################################################
  100.  
  101.     Lookup the files ${KAOSHOME}/modellib/*.info
  102.  
  103. ########################################################################
  104.     CHANGING PARAMETERS OF DYNAMICAL SYSTEM CLASS
  105.     BUILDING A NEW DYNAMICAL SYSTEM CLASS
  106. ########################################################################
  107.  
  108.     Lookup the file README ${KAOSHOME}/modellib
  109.  
  110.  
  111. ########################################################################
  112.     PORTING TO OTHER DIRECTORIES AND MACHINES
  113. ########################################################################
  114. To port kaos to other directories or other machines with the same 
  115. architecture, one needs to make a copy of kaos source codes.
  116.  
  117. Use the command "kar" in $KAOSHOME/bin. 
  118.  
  119. To create a tar file
  120. --------------------
  121. (1) Type "kar"
  122. (2) After the prompt "Enter a tar file name:", type the name of tar file.
  123. (3) You will see a list of copy options. Depending on your needs, 
  124. choose a proper option. (See the description on the screen for more info.)
  125.  
  126. To copy across the directories
  127. ------------------------------
  128. Type "bin/kar -c" from $KAOSHOME.
  129.  
  130. Note that the size of kaos may be one's major concern becase of the
  131. disc space constraint. Discard the groups of files you think are 
  132. less important. Typically the order of  directories to go is:
  133.     archive
  134.     data
  135.     contriblib
  136.     companionlib
  137.     PS
  138.     RAS
  139.     doc
  140.     info
  141.     examples
  142. Depending on one's need, 
  143.     auto
  144.     graph
  145.     batch
  146. kaos still would compile without all the above directories.
  147.  
  148. Theinstallation will be even faster if
  149. one does not have to recompile the source codes.
  150.  
  151. Global change of C flags
  152. ------------------------
  153. To remove the C debugging flags and optimize the compilation,
  154. type 
  155.     kedgr "-g" "-O" Makefile
  156.  
  157. After kaos has been mobe, rerun kaos_install to change the kaos
  158. home directory.
  159.  
  160.