Get IMS Open Corpus Workbench at Fast, secure and Free Open Source software downloads IMS Open Corpus Workbench Logo
Latest news
You can now get CQPwebInABox - a pre-prepared VM image!
Read the new Ziggurat data model specification.

Installation guide

Installing binary packages

Download the appropriate binary package for your platform. Then unpack the archive (usually with the command tar xfvz XXX.tar.gz) and follow the instructions in the INSTALL file. For a default installation, simply type sudo ./, and make sure that /usr/local/bin is in your search path.

For instance, to install CWB v3.0.0 in Mac OS X, you would download the package cwb-3.0.0-osx-10.5-universal.tar.gz and enter the following commands:

  tar xvfz cwb-3.0.0-osx-10.5-universal.tar.gz
  cd cwb-3.0.0-osx-10.5-universal
  sudo ./

If you want to install the CWB in a different location, you will have to edit the first lines of first as described in the INSTALL file. For instance, set PREFIX=~/cwb-3.0 to install the CWB binaries in a directory tree cwb-3.0/ in your own home directory. Make sure to add ~/cwb-3.0/bin to your search path in this case. Do not use the CWB directly from the distribution package without installing, as this will confuse other software that relies on accurate information from cwb-config.

You may want to test your new CWB installation with one of the pre-indexed demo corpora. Download and unpack the English demo corpus (novels by Charles Dickens), change to the directory DemoCorpus/, and try the following commands:

  cwb-describe-corpus -r registry -s DICKENS
  cqp -eC -r registry -D DICKENS
The first command will print some information about the corpus and its attributes, while the second will start an interactive CQP session and activate the demo corpus DICKENS for queries. Now follow the instructions in the CQP Query Language Tutorial for your first steps with the CWB, and read the Corpus Encoding Tutorial if you want to index your own corpora.

Specific installation guides for some platforms and additional tips & tricks can be found in the CWB wiki.

Compiling the CWB from source code

If you want to compile the CWB yourself, download the source code package and unpack the archive, or check out the cutting-edge version from the Subversion repository. Then follow the instructions in the README file. You will need a working C compiler as well as some other tools and libraries in order to complete this procedure.

Note that there are ready-made compile & install scripts for some widely-used operating systems in the install-scripts/ subdirectory. For instance, a default build for Ubuntu Linux can be compiled and installed with the single command:

  sudo install-scripts/cwb-install-ubuntu
The necessary prerequisites are automatically installed using the Ubuntu package manager.

You should also check the CWB wiki for further installation tips.

Perl API installation

The Perl API has been broken into multiple independent packages so that you only need to install the functionality needed for your purposes. The base package CWB is strongly recommended for all CWB users (since it provides essential utilities such as cwb-make and cwb-regedit). The other packages have additional prerequisites: CWB-CL requires a working C compiler for installation and CWB-Web depends on some external Perl packages available from CPAN. The CQi reference implementation CWB-CQI also works on client machines without a CWB installation.

Download the required Perl API packages, then unpack each archive (with tar xfvz Perl-CWB-{version}.tar.gz etc.) and follow the instructions in the respective README file.

Installing CQPweb

CQPweb has its own installation manual which comes as part of the package and is also available online.