Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Step

Example

1. Navigate to the source downloads for areleased version on SourceForge.net

Even without the full LVG data, cTAKES is about 790 MB when compressed.

2. Download the latest version.

Select the directory for the latest version and download the *ZIP*file.

Image Modified

3.
Unzip the file you downloaded into a directory that you want to be the
cTAKES install location. It will expand to about 1.4GB.
Windows:

Code Block
languagenone
c:\cTAKES-3.10


Linux:

Code Block
languagenone
/usr/bin/cTAKES-3.10



This folder we will call <cTAKES_HOME>. You will need to refer to the directory later.

Image Modified|

4. Set UIMA_HOME. UIMA requires a special environment variable for its commands to run.

Use the absolute path to the <cTAKES_HOME> directory in the previous step as the value.

Windows:
Right-click on Computer> Properties> Advanced> *Environment Variables*button > *New*button for System variables. Keep clicking *OK*until you are out of the dialog series.
Linux:
Use the command export UIMA_HOME=<cTAKES_HOME> for example:

Code Block
languagenone
export UIMA_HOME=/usr/bin/cTAKES-3.10

5. Edit PATH. This will be used for any command line access to binaries.
Windows:
Right-click on Computer> Properties> Advanced> *Environment Variables*button. Edit the *Path*environment variable adding *;<cTAKES_HOME>\bin*to the end. Keep clicking *OK*until you are out of the dialog series.
Linux:
Use the command export PATH=%PATH%:<cTAKES_HOME>/bin for example

Code Block
languagenone
export PATH=%PATH%:/usr/bin/cTAKES-3.10/bin

6. In Eclipse use File > New > Java Project ...

Uncheck Use default location*and navigate to *<cTAKES_HOME>*for location Click *Next>*Click *Finish.

Image Modified

7. Remove unnecessary JAR files.

Go to Project> Properties> Java Build Path> Libraries. Select all the entries except the JRE System Library and click the *Remove*button.


8. Add cTAKES folders as class resources.

Select Add Class Folder. Check the two class folders cTAKESdesc*and *resources. Click OK.


9. Add JAR files from <cTAKES_HOME>/lib.

Select Add Library*button > *User Library*list item > *Next >*button > *User Libraries*button > *New*button. Name the new user library *ctakes3.1lib0lib*and click *OK. Click the Add JARs...*button and Navigate to <cTAKES_HOME>\lib*. Select all the JAR files and click Open. Click OK. Click Finish.


10. Close the User Libraries dialog.

Click OK. Your Package Explorer should look something like this (next cell).




11. If you have Eclipse set to build automatically it will do so and you may continue to run and debug from Eclipse.

You can also setup Eclipse to run Ant builds using the Ant files shipped as seen on the right (next cell).

...

Step

Example

1. Install subversion or a suitable plug-in for your IDE.

No example

2. Check-out the code to a local directory, such as:

Code Block
languagenone
c:\cTAKES-3.10


This folder we will call <cTAKES_HOME>. You will need to refer to the directory later.
Pre-release versions are available from:

Code Block
languagenone
svn checkout https://ohnlp.svn.sourceforge.net/svnroot/ohnlp/trunk/cTAKES


Note

If you are checking out via Subclipse in Eclipse, make sure to check out each project separately.

Code Block
languagenone
...
A cTAKES\PAD term spotter\desc\type_system
A cTAKES\PAD term spotter\desc\type_system\PADSiteAndTerm.xml
A cTAKES\PAD term spotter\desc\analysis_engine
A cTAKES\PAD term spotter\desc\analysis_engine\Radiology_TermSpotterAnnotatorTAEStyleMap.xml
A cTAKES\PAD term spotter\desc\analysis_engine\Radiology_TermSpotterAnnotatorTAE.xml
A cTAKES\PAD term spotter\desc\analysis_engine\DxStatusAnnotator.xml
A cTAKES\PAD term spotter\desc\analysis_engine\NegationDxAnnotator.xml
A cTAKES\PAD term spotter\desc\analysis_engine\PAD_Hit.xml
A cTAKES\PAD term spotter\desc\analysis_engine\SubSectionBoundaryAnnotator.xml
A cTAKES\PAD term spotter\desc\analysis_engine\Radiology_DictionaryLookupCSVAnnotator.xml
A cTAKES\PAD term spotter\desc\collection_processing_engine
A cTAKES\PAD term spotter\desc\collection_processing_engine\Radiology_sample.xml
A cTAKES\PAD term spotter\desc\collection_reader
A cTAKES\PAD term spotter\desc\collection_reader\RadiologyRecordsCollectionReader.xml
A cTAKES\PAD term spotter\.settings
A cTAKES\PAD term spotter\.settings\org.eclipse.jdt.ui.prefs
Checked out revision 667.

3. In Eclipse use File > Import... > General > Existing Projects into Workspace

Use your local directory for the root directory. Leave all of the projects selected and click Finish.

Note

It may be necessary to import each project one by one!

4. Install UIMA 2.4. Make note of UIMA_HOME.

No example

5. Add UIMA JARs to the build path configuration in Eclipse. Add all JARs from:

Code Block
<UIMA_HOME>/lib
  • jVinci.jar
  • uima-adapter-soap.jar
  • uima-adapter-vinci.jar
  • uima-core.jar
  • uima-cpe.jar
  • uima-documentation-annotation.jar
  • uima-examples.jar
  • uima-bootstrap.jar
  • uima-tools.jar

6. Generate the common type system.

A bug in the ordering and generation currently requires that you go to your project properties> Java Build Path> *Order and Export*and move the *auto_generatesrc*directory to the top of the list.

Right-click on /cTAKESdesc/typesysytem/common_type_system.xml*and select *Open With> Component Descriptor Editor.
Click the *Type System*tab then the *JCasGen*button (in the center).

...