Page History

1. Download and install Eclipse 4.2+.

(optional) It is recommended that you start a new workspace to keep your cTAKES projects separate from other work.

No example

2. Subversion Eclipse plug-in (based on Subversive site). We will use the one called "Subversive - SVN Team Provider"

Help -> Install New Software...
Select the current Eclipse release (in the case of Eclipse 4 it is Juno) for the "Work with" field:

Juno - http://download.eclipse.org/releases/juno

Expand the Collaboration category.
Select "Subversive SVN Team Provider".
Click Next.
Click Next.
Agree to the license agreement.
Click Finish.
Restart Eclipse.

3. Subversion team provider connectors 1.7+.

After restarting Eclipse a dialog will ask you to install an SVN Kit for the Team Provider.
Select SVN Kit 1.7 or greater.
Click Finish.
Click Next.
Click Next.
Agree to the license agreement.
Click Finish.
Accept the security warning (if one appears).
Restart Eclipse.

Image Modified
Image Modified

4. Maven is already part of Eclipse, but more integration to Maven commands is needed.

Help -> Install New Software...
Select the current Eclipse release (in the case of Eclipse 4 it is Juno) for the "Work with" field:

Juno - http://download.eclipse.org/releases/juno

Expand the Collaboration category.
Select "m2e - Maven Integration for Eclipse".
Click Next.
Click Finish.
Restart Eclipse.

Image Modified

5. Maven SCM connector.

File -> Import ... -> Maven -> Check out Maven Projects from SCM.
Click Next.
Click the "m2e Marketplace" link.
You are now in the m2e Marketplace not the Eclipse Marketplace.
Scroll to and select m2e-subversive.
Click Finish.
Leave the defaults to install the "Maven SCM Handler for Subversive" and click Next.
Click Next.
Accept the license agreement.
Click Finish.
Accept the security warning (if one appears).
Restart Eclipse.

Image Modified
Image Modified

1. Import the cTAKES projects using Maven.

File -> Import ... -> Maven -> Check out Maven Projects from SCM.
Click Next.

2. For SCM URL use "svn" in the drop-down

https://svn.apache.org/repos/asf/incubator/ctakes/tags/ctakes-3.0.0-incubating

in the text field.
Click Finish.
Eclipse will download and builds all of the cTAKES projects including running jcasgen as needed. It may take up to 30 minutes depending on your machine and Internet speed.

Image Modified

1. Launching the UIMA CAS Visual Debugger (CVD) or the Collection Processing Engine (CPE) from Eclipse can now be accomplished in the ctakes-clinical-pipeline project:

ctakes-clinical-pipeline/resources/launch/UIMA_<CVD | CPE>GUI--clinical_documents pipeline.launch

where you must select between CVD and CPE in the command. Other Run Configurations are also available in the Eclipse Run menu.

Image Added

2. (Optional) Process data.

Now that you can launch the tools, the User Guide has steps to walk you through processing test data if you want to go there.

No example

1. Find UIMA Eclipse plug-ins.

Help> Install New Software...> Add... button
Set a repository name and this site location

http://www.apache.org/dist/uima/eclipse-update-site

Click OK.

Image Modified

2. Install UIMA Eclipse plug-ins.

Select the UIMA Eclipse tooling and runtime support.
Click Next.
Leave the defaults and click Next.
Accept the license agreement.
Click Finish.
Restart Eclipse.

Image Modified

3. (optional) Verify the installation of the UIMA Plug-ins. Go to Help -> About Eclipse -> Installation Details -> Plug-ins. You will see a dialog such as that i the next cell with plug-in names starting with "UIMA Eclipse:".

Image Modified

1. Install an SVN client.

Windows:
We used a binary package of Apache Subversion from SlikSVN.
Apache has a larger list here.
Download and run the MSI file.
Click Next.
Accept the license agreement.
Click Next.
Click Next.
Select Typical.
Select Install.
Wait
Click Finish.
Exit and restart any command prompts that were open.

Linux:

sudo apt-get install subversion

Windows:
Image Modified

Linux:

The following extra packages will be installed:
  libapr1 libaprutil1 libneon27-gnutls libsvn1
Suggested packages:
  subversion-tools db4.8-util
The following NEW packages will be installed:
  libapr1 libaprutil1 libneon27-gnutls libsvn1 subversion

...

Processing triggers for python-central ...
Processing triggers for man-db ...
Setting up libapr1 (1.4.2-7ubuntu2) ...
Setting up libaprutil1 (1.3.9+dfsg-5ubuntu3) ...
Setting up libneon27-gnutls (0.29.5-3) ...
Setting up libsvn1 (1.6.12dfsg-4ubuntu2) ...
Setting up subversion (1.6.12dfsg-4ubuntu2) ...

2. Install a Maven 3.0+ client.

Windows:
We downloaded Apache Maven file apache-maven-3.0.4-bin.zip. Install instructions are on the same page.
Unzip the file to the root drive.
C:\apache-maven-3.0.4 will be your MAVEN_HOME.

Linux:
We downloaded Apache Maven file apache-maven-3.0.4-bin.tar.gz. Install instructions are on the same page.
Unzip the file to /usr/local/apache-maven-3.0.4 which will be your MAVEN_HOME.

cd /tmp
wget http://apache.mirrors.pair.com/maven/maven-3/3.0.4/binaries/apache-maven-3.0.4-bin.tar.gz
sudo tar -xvf apache-maven-3.0.4-bin.tar.gz -C /usr/local

Windows:
Image Modified

Linux:
Image Modified

3. Set the Maven environment variable values -
M2_HOME=<MAVEN_HOME>
M2=<MAVEN_HOME>/bin
PATH=<existing Path>;<MAVEN_HOME>
where MAVEN_HOME is the path you unzipped to.

Windows:
Right-click on Computer > Properties > Advanced System Settings > Advanced tab > Environment Variables button > New button for User variables. Once the values are entered click OK until you are out of the dialog series.

Linux:

export M2_HOME=/usr/local/apache-maven-3.0.4
export M2=$M2_HOME/bin
export PATH=$PATH:$M2

Windows:
Image Modified
Image Modified
Image Modified


Linux:

tbleeker@system:~$ export
...
declare -x M2="/usr/local/apache-maven-3.0.4/bin"
declare -x M2_HOME="/usr/local/apache-maven-3.0.4"
declare -x PATH="/usr/lib/jvm/java-6-sun/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/apache-maven-3.0.4/bin"

1. Launching the UIMA CAS Visual Debugger (CVD) or the Collection Processing Engine (CPE) from Eclipse can now be accomplished in the ctakes-clinical-pipeline project:

export MAVEN_OPTS="-Xmx2g -Xms1g"
mvn -Prun<CVD | CPE> compile

where you must select between CVD and CPE in the command. Other Run Configurations are also available in the Eclipse Run menu.

Image Added No example

2. (Optional) Process data.

Now that you can launch the tools, the User Guide has steps to walk you through processing test data if you want to go there.

No example