Home / scipad-8.68
Name Modified Size InfoDownloads / Week
Parent folder
scipad-8.68-Scilab5.zip 2011-11-02 870.2 kB
scipad-8.68-Scicoslab.zip 2011-11-02 884.4 kB
scipad-8.68-readme.txt 2011-11-02 14.7 kB
Totals: 3 Items   1.8 MB 0
Scipad, maintained by Francois Vogel and Enrico Segre


Scipad is a powerful editor and graphical debugger for programs written
in Scilab language. It is a mature and highly configurable programmer's
editor, including features like syntax colorization, regexp search/replace,
parentheses matching, logical/physical line numbering, peer windows, line
and block text editing, and much more.

Scipad can be used along with Scicoslab or Scilab, but even as a standalone
text editor. Used as internal Sci(cos)lab editor, it interacts tightly with
the interpreter, allowing

    - Scilab code execution control
    - conditional breakpointing
    - variable retrieval and tooltip display
    - Scilab help lookup
    - access to source code of Scilab library function
    - control of Scilab facilities for Matlab code and creation of help
      documents
    - and much more

Scipad also includes basic Modelica and XML syntax colorization; it is
currently localized in 13 languages and further localizations can easily
be added.

Scipad is entirely written in Tcl/Tk and Scilab language. It has been
tested and developed under various versions of Windows and Linux;
it should run on MacOSX on top of certain environments (untested).

Historically, the ongoing versions of Scipad used to be included in the
distributions of Scilab (up to version 5.1.1). As this is no more the case,
this repository carries the latest developments of the continuing project.
Care has been taken to support at best all versions of Scilab and Scicoslab
since 4.1 to current, and all underlying versions of Tcl/Tk from 8.4.6 on.
Please note however that certain features may not be available in some
combinations of Sci(cos)lab or Tcl/Tk.

In particular:

    - The graphical debugger cannot work in any version of Scilab >= 5,
      because of broken communication support at source. For more details
      about the debugger in Scilab 5, please check this page:
        http://wiki.scilab.org/Scipad_debugger_inner_beauties
      For many, that could be a reason to stick to Scicoslab instead.
    - Peer editing is available only with Tk >= 8.5
    - Further specific issues are discussed in the tracker area.

Check out the Scipad project page:

  http://sourceforge.net/p/scipad/home/

Please see help Scipad for details about how to use this software once
installed.


----------------
-- DISCLAIMER --
----------------

This package has been developed and tested on Windows, mainly on Vista.

It is also working on Linux, but testing on this platform is a bit less
complete.

Note that Scipad worked with Scilab up to version 5.2.2 (inclusive), but
could not be launched with Scilab 5.3.0 nor 5.3.1 due to bug #7954 of
Scilab 5:
  http://bugzilla.scilab.org/show_bug.cgi?id=7954
This bug has now been fixed, and Scipad can again be launched with
Scilab 5.3.2 or later.

Please refer to the detailed tested combinations at the end of the present
readme file.


------------------
-- INSTALLATION --
------------------

Installation steps are the same for both Windows and Linux.


1. Case of a Scilab 5 environment
   ------------------------------

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

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

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

  c. 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 5 and restart it

  d. Now install Scipad with the following set of commands, 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

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

        scipad()

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


2. Case of a Scicoslab 4.4 (or more) environment
   ---------------------------------------------

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

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

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

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

  d. 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>

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

  f. 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.

  g. Quit ScicosLab.

  h. 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.


---------------------
-- 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 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
                       load TkDnD and 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)
    <TK85PATH>    by:  the full path of the directory named "tk8.5" in
                       Scilab/Scicoslab (this is needed only for the drag and
                       drop feature be working - Scipad can do without it)
    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)


-------------
-- REMOVAL --
-------------

1. Case of a Scilab 5 environment
   ------------------------------

Remove Scipad by issueing the following command:

  atomsRemove("scipad");


2. Case of a Scicoslab 4.4 (or more) environment
   ---------------------------------------------

You cannot completely remove Scipad since it is an integral part of the
Scicoslab software.
You may however install a different version of Scipad (a previous version or
a newer version) by following the same installation steps as provided above.


3. Case of a Scilab 4.1.2 environment
   ----------------------------------

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


-------------------------------
-- 32 bits vs 64 bits issues --
-------------------------------

Scipad runs in a 32 bits or 64 bits Tcl environment.
There are however a few subtleties, in particular concerning the DnD (drag and
drop) feature.


Scilab 5 environment (binary versions for Linux or Windows):
------------------------------------------------------------

    Scipad can be installed in Scilab 5 32 bits or 64 bits version.

    Scilab 5.x 32 bits binary is shipped with a Tcl/Tk 32 bits version, and
    with a 32 bits tkdnd library. The drag and drop feature
    of Scipad is directly supported.

    Scilab 5.x 64 bits binary is shipped with a Tcl/Tk 64 bits version, but
    without the tkdnd library. Therefore, if Scipad is installed in a 64 bits
    version of Scilab 5.x:
        On Linux: The tkdnd package may or may not be found by Scipad at
                  startup.
                  If it is found, it is because it is already present on the
                  system, perhaps because it is part of Scicoslab (see below).
                  If it is not found, the corresponding warning can be ignored
                  safely (but the DnD feature will obviously not be present),
                  or the package must be installed (the easiest is to pick it
                  from the Scicoslab website).
        On Windows: The tkdnd package will not be found by Scipad at startup.
                  There is currently no way to have DnD working in Scipad
                  running in a 64 bits Windows version of Scilab 5.x. The way
                  to go would be to compile under Windows x64 from the
                  following sources:
                    cvs -d:pserver:anonymous@tkdnd.cvs.sourceforge.net:/cvsroot/tkdnd login   (empty password)
                    cvs -z3 -d:pserver:anonymous@tkdnd.cvs.sourceforge.net:/cvsroot/tkdnd co -P tkdnd
                  Note that the CVS repository of the tkdnd project must be
                  used since it provides the sources for tkdnd 1.x. The SVN
                  repository contains tkdnd2.x, which is not yet working
                  (missing drag on Linux, and DnD not working at all with Gnome, for instance).


Scicoslab environment on Windows:
---------------------------------

    Scicoslab 4.4.1 binary is a 32 bits version only. It is shipped with a 32
    bits Tcl/Tk version and a 32 bits tkdnd library. The drag and drop feature
    of Scipad is directly supported.


Scicoslab environment on Linux:
-------------------------------

    Scicoslab 4.4.1 binaries are 32 bits or 64 bits versions. They are shipped
    without Tcl/Tk nor tkdnd, which are dependencies of Scicoslab. The
    Scicoslab website provides 32 bits and 64 bits tkdnd packages that must
    be installed separately in order to get the drag and drop feature of
    Scipad.


Standalone Scipad:
------------------

    Scipad runs in a 32 bits or 64 bits Tcl environment.
    Care must be taken when giving <TK85PATH> (see above) such that the tkdnd
    library in this folder be compatible with the Tcl/Tk version running
    Scipad, i.e. 32 bits and 64 bits binaries must not be mixed. For instance
    running Scipad in standalone mode in a 64 bits Tcl/Tk environment and
    setting <TK85PATH> to point to a 32 bits tkdnd library will result in the
    "tkdnd package not found" error message.


--------------------------------------------
-- COMBINATIONS TESTED, WITH TEST RESULTS --
--------------------------------------------

The following combinations have been tested (with Scipad 8.63):
All Scilab/Scicoslab versions are 32 bits binaries.

  WINDOWS VISTA (64 bits)
                                         Install    Run     DnD
    Scilab 5.3.3                       :   ok       ok      ok
    Scicoslab 4.4                      :   ok       ok      ok
    Scilab 4.1.2                       :   ok       ok      ok
    Standalone                         :    -       ok      ok


  WINDOWS 7 (32 bits)
                                         Install    Run     DnD
    Scilab 5.3.3                       :   ok       ok      ok
    Scicoslab 4.4                      :   ok       ok      ok


  LINUX UBUNTU 10.04.1 Lucid Lynx (32 bits)
                                         Install    Run     DnD
    Scilab 5.3 nightly build 19Mar2011 :   ok       ok      ok
    Scicoslab 4.4                      :   ok       ok      ok


  LINUX UBUNTU 10.10 Maverick Meerkat (32 bits)
                                         Install    Run     DnD
    Scilab 5.3 nightly build 18Mar2011 :   ok       ok      ok
    Scicoslab 4.4                      :   ok       ok      ok


  LINUX FEDORA 14 (32 bits)
                                         Install    Run     DnD
    Scilab 5.3.1                       :   ok       KO(1)
    Scilab 5.3 nightly build 18Mar2011 :   ok       ok      ok
    Scicoslab 4.4                      :   ok       ok      ok


  LINUX DEBIAN 6.0.0 Squeeze (32 bits)
                                         Install    Run     DnD
    Scilab 5.3 nightly build 18Mar2011 :   ok       ok      KO(2)
    Scicoslab 4.4                      :   -(3)     -       -

 (1) Due to Scilab bug 7954 not fixed in this Scilab 5 version
 (2) tkdnd package cannot be found (for other linuxes, it is provided as part
     of the Scicoslab installation)
 (3) No Scicoslab package available for this platform at the time of testing

Source: scipad-8.68-readme.txt, updated 2011-11-02