SWISH Kepler Actors Installer - Details

The installer

Required software

To use SWISH Kepler Actors, Kepler 2.4, Java JRE or JDK, Stata 12, R, and Microsoft .Net framework 4 are required. The installer is built to work on Microsoft Windows systems, and will not work correctly on Linux systems. The installer will need to be run for each user that wishes to user SWISH Kepler actors.

Kepler: https://kepler-project.org/

Java 6: http://www.oracle.com/technetwork/java/javase/readme-142177.html

Microsoft .net framework 4 is available on Windows 7, but will need to be additionally installed for Windows Vista or XP. It is available at http://www.microsoft.com/en-us/download/details.aspx?id=17851

Stata 12: http://www.stata.com/stata12/

R: http://www.r-project.org/

The installer tests to see if it can find installed versions of Kepler, R, Java, and Stata. If these are not installed SWISH Kepler Actors may not run, and the installer will display a warning. The installer has trouble finding with some versions of R, in this case the warning can be safely ignored.

If found the installer adds the locations of R and Java to your systems PATH environmental variable.

Installer arguments

The installer can be run directly and provided with arguments. The installer is called "Swish.SimpleInstaller.exe" and located in the installer bin folder. To run the graphical user interface (GUI) normally provide no arguments. To uninstall use the ">clean" argument. To install or uninstall automatically with no user interface add the ">silient" argument. To display extra information during the process add the ">verbose" argument, this can help find errors if the process fails. To launch Kepler after installing use the ">launch" argument.

You can run the installer directly using the command prompt. Enter "Swish.SimpleInstaller.exe" and then any arguments separated by spaces.

EG: to uninstall, when the installer in on the desktop

C:\Users\Ian\Desktop\SwishInstaller\Swish.SimpleInstaller.exe >clean >silent

[Note you can open the command prompt by pressing WindowsKey + R and enter "cmd"]

Installer Script

The installer copies actor files to where they will be automatically loaded by Kepler and copies executable files to where they are used by the actors. The Actor files are copied to the directory "C:\Users\%UserName%\KeplerData\workflows\MyWorkflows", where %UserName% is the name of the user profile logged on during installation. Executable files are copied to the "C:\Swish\bin" directory. The files copied during installation can all be found under the installer "%Installer%\bin" folder. Files in the "%Installer%\bin\Actors" are copied to the "C:\Users\Ian\KeplerData\MyWorkflows", and files in "%Installer%\bin\SwishBin" are copied to "C:\Swish\bin".

To include additional actors with the installer simply add them to the ""%Installer%\bin\Actors" directory.

The installer follows instructions found in install.txt. This file can be edited as new files are added to the installer.

If the installer in installing the software then each line of install.txt is carried out in order. If the installer is removing the software then install.txt is read in reverse line order and the opposite of each action is carried out where possible.

Commands

Each line of install.txt is in the format

ActionName arguments

Where arguments are separated by spaces, strings are escaped and surrounded with "'s.

NameArgumentsInstall actionClean action
DeleteFilesAndDirectories"directory"Deletes the directory and all contentsN/A
Delete"fileName"Deletes the fileN/A
DateAfterYear Month Day InstructionOnly executes the following instruction after the dateOnly executes the following instruction after the date
DateBeforeYear Month Day InstructionOnly executes the following instruction before the dateOnly executes the following instruction before the date
RunProcessRunProcess "executable" argumentsExecute processExecute process
CopyFilesAndDirectories"sourceDirectory" "destinationDirectory"Copies the directory, and any files and sub directories.Deletes the files found in the source directory and if empty deletes sub directories and destination directory.
CopyFiles"sourceDirectory" "destinationDirectory"Copies the files in the source directory to the destination directory.Removes the files in the source directory from the destination directory.
Copy"sourceFileName" "destinationFileName"Copies the file and creates the underlying directory if necessary.Removes the destination file if it exists.
MakeShortCut"fileName" "targetFileName" "arguments" "description"Creates a shortcut to a target file or target executable. The shortcut is saved at the path specified by fileName. Deletes the shortcut.
AddPath"binPath"Attempts to add the binPath to the system PATH environment variable. On failure it adds it to the user PATH variable.N/A
AddRegistryKey"path" "key" "value"Sets the value of the key located at path in the system registry.Sets the key value to NULL.
//N/AIgnored commentIgnored comment
N/AIgnoredIgnored
N/AInvalid line error reported.Invalid line error reported.

Examples:

AddPath "%RBin%"

Copy "%StartupPath%\SampleData\Kaleen.csv" "C:\Swish\SampleData\Kaleen.csv"

DateAfter 2014 01 01 RunProcess "%StartupPath%\UpdateCheck.exe" ""

Symbols

Several symbols are defined that are determined when the installer is run. Some values and paths may change depending on the user running the software. These symbols can used instead of specific paths in install.txt.

NameDescription
%UserProfile%Directory of the user profile. Eg on Windows 7 it will be something like C:\Users\Ian\. On windows XP it will be something like C:\Documents and Settings\Ian\
%StartupPath%Start directory of the installer running
%StartMenu%Directory of the system start menu
%SystemStartup%Directory of the system startup
%KeplerBin%If found directory where Kepler is installed
%RBin%If found directory where R is installed
%JavaBin%If found directory where Java is installed