wiki:SkE/Packages
Last modified 10 months ago

Sketch Engine installation packages

All installation packages for Sketch Engine are available for download at  Sketch Engine downloads.

System requirements

  • Linux 2.6x
  • 1 GHz processor and 1 GB of memory at least (4 GB recommended for normal usage, 8 GB for accessing large [=over 1G of tokens] corpora)
  • free disk space according to what corpora you are going to use

What are available installation options and which one should I choose?

We distribute three form of installation packages: source archives, RPM and DEB packages. We strongly encourage to use the binary RPM or DEB packages that are easy to install and maintain. If you require preparing RPM or DEB package for another distribution, please contact  support@sketchengine.co.uk.

RPM

http://fedoraproject.org/w/uploads/2/2d/Logo_fedoralogo.png http://wiki.centos.org/ArtWork/Logo/Horizontal?action=AttachFile&do=get&target=h-5c-a-293.png http://upload.wikimedia.org/wikipedia/en/thumb/6/6c/RedHat.svg/200px-RedHat.svg.png

The RPM packages have been compiled for Fedora 14 (contain "fc14" in their names), RHEL 5/CentOS 5 (contain "el5" in their names) but should be usable other RPM-based Linux distributions (Mandriva, OpenSUSE/SUSE etc.) as well. Each RPM package name contains either "i686" (32bit) or "x86_64" (64bit) or "noarch" (can be used on both 32bit and 64bit).

DEB

https://wiki.ubuntu.com/Brand?action=AttachFile&do=get&target=blackeubuntulogo.png

The DEB packages have been compiled for Ubuntu 10.04 Lucid Lynx but should be usable on most DEB-based Linux distributions (Debian etc.). Each DEB package name contains either "i386" (32bit) or "amd64" (64bit) or "all" (can be used on both 32bit and 64bit).

32bit or 64bit

We recommend using 64bit packages if your system supports them -- to find out, look at the output of "uname -m". If it is "x86_64", you are running an 64bit operating system.

How to install binary packages

RPM

prerequisities

  • on Fedora type as root: yum install antlr3-C pcre httpd python-cheetah
  • on CentOS/RHEL type as root: yum install httpd python-cheetah
  • on other RPM-based distributions, install corresponding packages or refer to the prerequisities of source archive installation (below).

installation instructions

  • create a temporary directory: mkdir ske_install; cd ske_install
  • download the following packages from the download site: finlib, manatee, manatee-python, bonito2, bonito2-www and for RHEL/CentOS also antlr3-C and pcre (>= 8.10) either
    • in a single all-in-one archive that you unpack afterwards (tar xjvf all-in-one-<version>.tar.bz2) or
    • selectively. For this you need one file (<package>-<version>-<architecture>) for each of the above packages with matching version numbers where the "architecture" is the suffix pattern as stipulated above for the linux distribution and 32/64 bit operating system. You would usually require the highest version number, which is the file at the top of each listing. Unless you specifically want the to develop new applications (using the -devel and -debuginfo packages) or make use of API bindings for Java/Ruby/Perl? (using -java, -ruby, -perl packages) there is no need to download these files.
  • login as root or type sudo bash if you use sudo
  • type rpm -ivh *
  • open the file /var/www/bonito2/run.cgi and at the bottom of the file, change os.environ['MANATEE_REGISTRY'] = '/corpora/registry' so that it points to the directory with your corpus configuration files (by default /corpora/registry).

DEB

prerequisities

  • on Ubuntu type as root: apt-get install libpcre3 libpcre++-dev apache2 python-cheetah
  • on other DEB-based distributions, install corresponding packages or refer to the prerequisities of source archive installation (below).

installation instructions

  • create a temporary directory: mkdir ske_install; cd ske_install
  • download the following packages from the download site: finlib, manatee, manatee-python, bonito2, bonito2-www and libantlr3c either
    • in a single all-in-one archive that you unpack afterwards (tar xjvf all-in-one-<version>.tar.bz2) or
    • selectively. For this you need one file (<package>_<version>_<architecture>) for each of the above packages with matching version numbers where the "architecture" is the suffix pattern as stipulated above for the linux distribution and 32/64 bit operating system. You would usually require the highest version number, which is the file at the top of each listing. Unless you specifically want the to develop new applications (using the -dev and -dbg packages) or make use of API bindings for Java/Ruby/Perl? (using -java, -ruby, -perl packages) there is no need to download these files.
  • login as root or type sudo bash if you use sudo
  • type dpkg -i *
  • open the file /var/www/bonito2/run.cgi and at the bottom of the file, change os.environ['MANATEE_REGISTRY'] = '/corpora/registry' so that it points to the directory with your corpus configuration files (by default /corpora/registry).

Post-installation steps

Depending on what corpora you have and where they are located you have to edit the file /var/www/bonito2/run.cgi:

  • the line corplist = ['susanne', 'bnc'] contains a list of available corpora
  • the line corpname = 'bnc' sets the default corpus
  • the line os.environ['MANATEE_REGISTRY'] = '/corpora/registry' is the path to the directory with corpus configuration files

After that, you should start your webserver if it is not running yet (try /etc/init.d/apache2 start or /etc/init.d/httpd start) and you should be able to access Sketch Engine via your regular web browser by typing localhost/bonito into the address bar.

source archives

We strongly encourage to use the binary RPM or DEB packages that are easy to install and maintain. If you require preparing RPM or DEB package for another distribution, please contact  support@sketchengine.co.uk.

prerequisities

compilation and installation instructions

  • download source archive for finlib-<version>
  • unpack and change to the directory: tar xjvf finlib-<version>; cd finlib-<version>
  • type ./configure --with-pcre --enable-sketchengine
  • type make
  • login as root
  • type make install
  • type ldconfig
  • download source archive for manatee-<version> and repeat all the steps above for it
  • download source archive for bonito2-<version>
  • unpack and change to the directory: tar xjvf bonito2-<version>; cd bonito2-<version>
  • type ./configure --enable-sketchengine
  • type make
  • login as root
  • type make install
  • type ./setupbonito2 <CGIPATH> <DATAPATH> where CGIPATH is the your webserver document directory and DATAPATH is a data directory writable by the webserver
  • depending on what you chose as CGIPATH in previous step, open the <CGIPATH>/run.cgi file and at the bottom of the file and make necessary changes as mentioned in the post-installation steps.

Upgrading packages

  • RPM: run rpm -Uvh <package_name> where <package_name> stands for the new .rpm file of the particular package you want to upgrade to
  • DEB: run dpkg -i <package_name> where <package_name> stands for the new .deb file of the particular package you want to upgrade to
  • source tarballs: proceed as for the installation step of each package

Downgrading packages

  • RPM: run rpm -Uvh --force <package_name> where <package_name> stands for the .rpm file of the particular package you want to downgrade to
  • DEB: run dpkg -i --force-downgrade <package_name> where <package_name> stands for the .deb file of the particular package you want to downgrade to
  • source tarballs: proceed as for the installation step of each package

Removing packages

  • RPM: run rpm -e <package_name> where <package_name> stands for the new .rpm file of the particular package you want to remove
  • DEB: run dpkg -r <package_name> where <package_name> stands for the new .deb file of the particular package you want to remove
  • source tarballs: run make uninstall in the original installation directory of each package