Installation

Home

Available Platforms

Basic System

A user can use most of KiNOKO's functions, including data acquisition and reading and writing data files, with an OS and C++ compiler that complies with UNIX System V Release 4 (SVR4). (This will not include the GUI however.)

Optional Software

KiNOKO becomes more useful if you have access to the following software besides the ones mentioned above. Especially the ones labeled "Strongly Recommended" are important to install (These software are installed with standard configuration on most Linux distributions). From here on, we assume that "Strongly Recommended" software are installed.
GTK+ library (2.4 or later) [Strongly Recommended]: http://www.gtk.org/
libxml library [Strongly Recommended]: http://xmlsoft.org/
For KiNOKO's GUI interface.

Perl [Strongly Recommended]: http:www.perl.com/CPAN/
To make several utilities attached to KiNOKO available.

zlib library [Recommended]: http://www.gzip.org/zlib/
For data compression functions.
This library needs to be linked in order to read compressed data as well.

GNU/readline library [Recommended]: http://www.gnu.org/directory/readline.html
Makes command lines easier. Curses or ncurses library must be installed to use this (installed with normal setup).

ROOT [Recommended]: http://root.cern.ch/
Users will be able to display histograms, etc using scripts Kinoko automatically generates.
Users will be able to save histograms etc generated by Kinoko online in ROOT format.
The interpreter version of KinokoScript will be able to read and write ROOT files.

SQL Data Bases
Users will be able to access a database in many situations. The following list contains database systems that are supported by Kinoko as of April '03.

XSLT Processors
Files such as HTML files can be automatically generated from Run Summary files that Kinoko generates in XML format. The following are some of the XSLT processors that are available for free.

Compiling

  1. Unpack the package at the directory you want to install kinoko.

      % cd the directory you want to install kinoko
      % gunzip kinoko.tar.tz
      % tar xvf kinoko.tar
    

    A new directory kinoko will be created.

  2. 'configure' the source codes to make them fit to your platform.

      % cd kinoko/src
      % ./configure-for LINUX
    

    'configure-for' is a shell script that executes configure with sets parameters, such as compiler options, according to its argument prior to executing the script.

    The current configuration option definitions are the following:

    NameCompilerCompiler OptionLibraries
    LINUXg++-WallGTK, SQLDB, ROOT, ...
    LINUX-MINg++NoneGTK
    OSXg++-m32 -WallGTK-OSX, ROOT
    AIXxlC-Wl,-bbigtocNone
    AIX64xlC-Wl,-bbigtocNone
    AIX-GCCg++NoneNone
    CCNETg++Nonecamlib for CCNET
    Optional second arguments can be passed to the compiler as well like the following.
    % ./configure-for LINUX "-g -O2"
    

    Instead of using configure-for, you can manually set parameters and use configure directly. (The following is a csh/tcsh example)

    % setenv CXX "g++"           
    % setenv CPPFLAGS ""
    % setenv CXXFLAGS "-Wall -g"
    % setenv MAKE "gmake"
    % ./configure --without-readline --with-PostgreSQL
    
    *The first line will become export CXX="g++" in a BASH shell.

  3. Compile the code. It will take 10 to 15 minutes on a PentiumIII PC.

    % make
    

    If compilation is successful, the following line will be displayed.

    Make: successful
    

Installing Device Drivers

Install device drivers appropriate to the devices you will use.
To use the CC/7x00 CAMAC controller (Toyo) or the CCP-PCI CAMAC controller (Hoshin) on Linux:
Install the 'camdrv' driver, which comes with the Kinoko package. The driver source is in the 'kinoko/drv/camdrv' directory. Refer to the camdrv home page to get the installation instructions.

The simplified steps to install are shown here. You must remember that proper settings such as jumper settings on the device itself are required too.

% cd kinoko/drv/camdrv/LinuxVerstion-devicename
% make
% su
# make install
# exit
To use Model-617/618/620 VME controller (SBS Technologies, or Bit3) on Linux:
Install the 'vmedrv' driver, which comes with the Kinoko package. The driver source is in the 'kinoko/drv/vmedrv' directory. Refer to the vmedrv home page to get the installation instructions.

The simplified steps to install are shown here. You must remember that proper settings such as jumper settings on the device itself are required too.

% cd kinoko/drv/camdrv/LinuxVerstion-devicename
% make
% su
# make install
# exit

Setting Environmental Variables

When you compile Kinoko, the files kinoko-cshrc and kinoko-bashrc are created in kinoko/src. Add these to .cshrc(or.tcshrc) or .bashrc in your home directory.
If you are using 'tcsh':
% cat kinoko-cshrc >> $HOME/.cshrc
If you are using 'bash':
$ cat kinoko-bashrc >> $HOME/.bashrc

The following is an example of kinoko-cshrc generated by this process.

### Kinoko Settings ###

setenv KINOKO_ROOT /usr/local/kinoko
setenv KINOKO_XTERM /usr/X11R6/bin/kterm
setenv KINOKO_RSH /usr/bin/ssh
setenv KINOKO_CONTROL_PORT_BASE 40000
setenv KINOKO_DATASTREAM_PORT_BASE 42000
setenv KINOKO_SHELL_PORT_BASE 45000
setenv KCOM_PATH ".:${KINOKO_ROOT}/bin"
setenv PATH "${PATH}:${KINOKO_ROOT}/bin"


Edited by: Enomoto Sanshiro