These are instructions for installation of cTAKES for developers. With these instructions you can set up your development environment with cTAKES code, compile the code, change or extend the code, and deploy. If you simply want to be a user of the software, refer to the cTAKES 3.1 User Install Guide.

These install instructions do not supply knowledge of what the cTAKES components do. This is found in the cTAKES 3.1 Component Use Guide.

Once you have compiled the code you can process documents with the cTAKES components. The documents upon which you can run cTAKES will take many forms. An example of doing this is covered in the Processing Documents section.

The minimal install instructions below are short but require a lot of prerequisite setup on your own. If you need more help then follow the step by step instructions. The step by step instructions for Eclipse assume a Windows or Ubuntu Linux install environment. You will need to extrapolate for any other environments.

Eclipse minimal install instructions

Prerequisites: Java JDK 1.6+, Eclipse IDE 4.2+, subversive plugin (or svn equivalent with appropriate SVN team provider connectors), m2e plugin (or mvn equivalent)

The following location is the main trunk of cTAKES. See how cTAKES treats the trunk, branches, and tags in the developer FAQs.

  • Import Project > Maven > Checkout Maven Project from SCM and use: svn and
  • Select all projects.
  • Wait until Eclipse downloads and builds all of your projects (it may take up to 30 minutes depending on the machine).
    • The various build helpers should run jcasgen and build the projects for you. There should not be any reason to run mvn install, etc.
  • Merge the version-matching resources ZIP file from into your ctakes-dictionary-lookup-res project.
  • (Optional) If you would like to launch the UIMA CVD or CPE GUI, run ctakes-clinical-pipeline/resources/launch/UIMA_<CVD | CPE>GUI--clinical_documents pipeline.launch
  • (Optional) UIMA plug-ins called "UIMA Eclipse tooling and runtime support" can be installed from update site:

Eclipse step by step install instructions

The install for cTAKES 3.1 is very similar to the install for cTAKES 3.0, except for the following

  • When downloading the separately-downloadable resources, download instead of
  • There are more components in cTAKES 3.1 than there were in cTAKES 3.0

While noting the things above, see the cTAKES 3.0 Developer Install Guide for the step-by-step instructions.

  • No labels