Installation

INSTALLATION

Installation steps are the same for both Windows and Linux.

1. Case of a Scilab 5 (or higher) environment

Scipad is distributed as a zipped atoms package in source form.
Installation steps are:

1. Download the package: scipad-X.YY-Scilab5.zip

2. Save it where you want, say in a directory <MYDIR>

3. Check if another version of Scipad is already installed by issueing:

   atomsIsInstalled("scipad")
   

   If the command above returns true, then the existing version of Scipad
   must be removed first through:

   atomsRemove("scipad")
   

   Then quit Scilab and restart it.

4. Now install Scipad with the following set of commands (you need to do
   this only once), replacing <MYDIR> by the folder where you saved the
   package, and X.YY by the Scipad version number:

   scipver = "X.YY";
   atomsSetConfig("offLine","True");
   atomsInstall(<MYDIR>+"/scipad-"+scipver+"-Scilab5.zip");
   if ~exists("atomsinternalslib") then
     load("SCI/modules/atoms/macros/atoms_internals/lib");
   end
   execstr("exec("""+atomsGetInstalledPath(["scipad" scipver])+"/builder.sce"",-1)");
   atomsLoad("scipad");
   

   Note: <MYDIR> must be the fully expanded directory name, it must not
   use the ~ alias for the user home directory

5. You can then launch Scipad, e.g. through the command:

       scipad()
   

6. When restarting Scilab later, it will automatically remember Scipad is
   installed

2. Case of a Scicoslab 4.4 (or higher) environment

Scipad is distributed as a zip file.
Installation steps are:

1. Download the package: scipad-X.YY.-Scicoslab.zip

2. Uncompress it somewhere, say in a directory <MYDIR>
   <MYDIR> is a path ending with /scipad-X.YY-Scicoslab

3. In Scicoslab, type SCI to know the installation directory of ScicosLab.
   This folder is referred to below as <SCI>
   Quit Scicoslab.

4. Copy/paste the content of the unzipped directory into the installation
   directory of ScicosLab.

   Note that this requires root privileges, and that you may be asked to
   accept overwriting of existing files.

   on Linux: sudo cp -r <MYDIR>/* <SCI>

5. Open ScicosLab with root/admin privileges, i.e.:
   on Linux: sudo scicoslab
   on Windows (Vista or 7): Execute as administrator

6. In ScicosLab, issue:

   genlib("utillib");
   

   A warning saying that "utillib has been updated, but cannot
   be loaded into Scilab because utillib is a protected variable"
   may appear (depending on versions), and can be ignored.

7. Quit ScicosLab.

8. Reopen ScicosLab and enjoy:

   scipad()
   

3. Case of a Scilab 4.1.2 environment

The same recipe as for a Scicoslab environment should be used.

4. Standalone mode

Scipad can be run in standalone mode, i.e. with no Scilab or Scicoslab
environment running under its feet. Obviously in such a case no action
requiring communication with an underlying environment can be executed.
This includes the debugger and a number of commands such as
"Execute in Scilab", "Open source code of...", "Import Matlab file...",
"Create help skeleton..." and a few more.

Running Scipad standalone is often used for debug purposes, but it is also a
way of having a nice editor at hand.

It requires Tcl/Tk be installed on your system. If this is not already the
case, please check the Internet for explanations about how to install Tcl/Tk
for your favourite platform.

Then, Scipad can be launched from wish very easily, by executing the following
snippet:

catch {unset pad}
cd <SCIPADTCL>
set Scilab5OrHigher false ; set Scilab6 false ; set Scilab5 false ;
set Scilab4 false ; set Scicoslab true
set env(SCIINSTALLPATH) <SCIINSPATH>
set env(SCIHOME) <SCIHOME>
set env(SCIPADINSTALLPATH) <SCIPADROOT>
lappend ::auto_path <TK85PATH>
source scipad.tcl
console hide  ; # optional (the console is normally used to debug Scipad)

In this script you have to replace:

• <SCIPADTCL> by: the directory where the file "scipad.tcl" is located
• <SCIINSPATH> by: the root directory of Scilab/Scicoslab (this is used to
  dynamically retrieve the Scicos keywords to colorize)
• <SCIHOME> by: the directory returned by the command SCIHOME in
  Scilab/Scicoslab (this is where the Scipad preferences
  file is saved)
• <SCIPADROOT> by: the full path of the directory where Scipad is installed
  (this is the same as <SCIPADTCL> for a Scipad version
  targeted to Scicoslab, but it is not for a Scipad
  version targeted to Scilab 5)

• true/false flags: according to the version you're using. The above is for a
  version of the type '*-Scicoslab.zip'. If youd like to
  use a version of the type '*-Scilab5.zip', then rather use:

      set Scilab5OrHigher true ; set Scilab6 false ; set Scilab5 true ;
      set Scilab4 false ; set Scicoslab false
  

Warnings:

• filepaths containing spaces must be enclosed by double quotes (")

• even on Windows, you should use the Linux path separator /, not the
  Windows antislash character \ (or escape it by doubling it)

• there were a few subtleties concerning 32 bits vs 64 bits environments, but since Scipad-8.71 this is no longer the case