Versions Compared

Key

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

...

Step

Example

1. Navigate to the cTAKES downloads page on the Apache site and download the binary package. Select a mirror site and press the Change button to modify the URL to your desired mirror location before doing the download or accept the default.

Windows:
Download the ZIP file.
Linux:
Use wget to obtain the *.TAR.GZ file.
wget <URL of the file from downloads>

Info

The download time will be commensurate with ~165MB of data.

Windows:

Linux:

Code Block
languagenone
HTTP request sent, awaiting response... 200 OK
Length: 763500777 (728M) [application/x-gzip]
Saving to: `apache-ctakes-3.0.0-incubating-bin.tar.gz'

13% [===========>                                     ] 106,548,331 1.13M/s eta 11m 9s

2. (Optional but recommended) Verify the downloaded files against a file signature to ensure you have the proper and complete file.

No example

3. Unzip the file you downloaded into a directory that you want to be the cTAKES install location. The compressed files contain a single directory at the top level. This folder we will call <cTAKES_HOME>. You will need to refer to this directory later.

Windows:

Code Block
languagenone
C:\apache-ctakes-3.0.0-incubating

Linux:

Code Block
languagenone
/usr/local/apache-ctakes-3.0.0-incubating

Windows:

Linux:

Code Block
languagenone
tar -xvf apache-ctakes-3.0.0-incubating-bin.tar.gz -C /usr/local 

4. Download cTAKES 3.0 Dictionaries and models.

Info

Due to licensing considerations and easy of installability, one download from an external location was established with all the resources you will need. Licensing for these resources is found within the download.

Info

Download time will be commensurate with 1GB of data.


Windows:
Go to cTAKES resources Go to http://sourceforge.net/projects/ctakesresources/files/ and download the ZIP file with a matching version from the ctakesresources project.
Download time will be commensurate with 1GB of data.
Unzip the files into Unzip the files into a temporary location such as C:\temp.

Linux:
Obtain the URL of the version matching ZIP file from cTAKES resources, get the file, and unzip to a temporary location.

Windows:
46

Linux:

Code Block
langnone
C:\temp\cd /tmp
wget http://sourceforge.net/projects/ctakesresources/files/ctakes-resources-3.0.1\resources

Linux:

Code Block
langnone
/tmp/.zip
sudo unzip ctakes-resources-3.0.1/resources.zip

5. Copy (or move) the resources to cTAKES_HOME.
Copy the contents of the temporary resources directory (and all sub-directories) to <cTAKES_HOME>/resources.

Info

There may be conflicts while taking this action. Overwrite the cTAKES_HOME files with those in the resources download.



Windows:

Code Block
langnone
xcopy /s C:\temp\ctakes-resources-3.0.1\resources C:\apache-ctakes-3.0.0-incubating\resources

Linux:

Code Block
langnone
cp /tmp/ctakes-resources-3.0.1/resources/* /usr/local/apache-ctakes-3.0.0-incubating/resources/*

...

Step

Example

1. Open a command prompt and change to the cTAKES_HOME directory:

Note

It is best if <cTAKES_HOME> is your current directory. The scripts will change directories, so being home to run the command is best.


Windows:

Code Block
languagenone
cd \apache-ctakes-3.0.0-incubating

Linux:

Code Block
languagenone
cd /usr/local/apache-ctakes-3.0.0-incubating

2. Create a directory for some test data.

Windows:mkdir testdata

3. Download this sample file and place it into the testdata directory.

No example

4. Start the collection processing engine by running this command:
The application may take a minute to start on slower hardware.

Windows:

Code Block
languagenone
bin\runctakesCPE.bat

Linux:

Code Block
languagenone
bin/runctakesCPE.sh

5. This will bring up the Collection Processing Engine Configurator. In the Menu bar click File >Open CPE Descriptor

6. Navigate to the file

Code Block
langnone
<cTAKES_HOME>
  /desc
    /ctakes-clinical-pipeline
      /desc
        /collection_processing_engine
          /test1.xml


Click Open.

No example

7. Change the Collection reader input directory to testdata and the CAS Consumer output directory to testdata/output in the CPE fields

Image Modified

8. Click the Play button (green/blue play arrow near the bottom).

Info

What just happened? You placed a sample CDA document into the input of a pipeline. The pipeline was a file system reader that will process all files in a directory. The processing was accomplished by the chunker cTAKES component (noted by the descriptor that you opened). One resulting file for each input file was placed into the output directory. This output file is an XML file that annotates the noun phrases and verb phrases.

9. You should see that one document was processed. You did process a collection of documents. In this case the collection only contained one just to show how to do it. Close the results window.

Image Modified

10. Close the CPE application. You may be prompted to save changes. Since this was just a test you may click the No button.

No example

...