Page History

...

These install instructions do not supply knowledge of what the cTAKES components do. That is found in the cTAKES 4.0 Component Use Guide and the pages for the individual components.

Below are instructions for Eclipse and for IntelliJThe 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

...

• Import Project > Maven > Checkout Maven Project from SCM 
  • use: svn and https://svn.apache.org/repos/asf/ctakes/trunk
  • Select the option to Check out Head Revision.
  • Select the option to Check out All Projects.
• Wait until Eclipse downloads and builds all of your projects (it may take up to 30 minutes or more depending on your internet connection and your hardware).
  • The various build helpers should run jcasgen and build the projects for you. There should not be any reason to run mvn install, etc.
• If you are using the Fast Dictionary Lookup, the dictionary will be downloaded for you when you do a maven build.
• If you want to use the full LVG or original dictionary lookup, merge resources from https://sourceforge.net/projects/ctakesresources/files/ctakes-resources-4.0-bin.zip/download into the relevant projectsubproject.
• (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: http://www.apache.org/dist/uima/eclipse-update-site 

Eclipse step by step install instructions

• These steps assume a Windows or Ubuntu Linux install environment. You will need to extrapolate for any other environments.
• These steps Recommend choosing "Eclipse IDE for Java Developers" package when downloading Eclipse (These were written using Mars aka Eclipse 4.5. You may need to adapt some steps for other version of Eclipse)versions of Eclipse.
• Recommend choosing "Eclipse IDE for Java Developers" package when downloading Eclipse 
• Within Eclipse, install Install the Maven SCM connector
  • File -> Import -> Maven -> Check out Maven Projects from SCM
  • Click Next.
  • Click the "m2e Marketplace" link (somewhat above the Cancel button)
  • You are now in the m2e Marketplace not the Eclipse Marketplace. 
  • Scroll to and select m2e-subversive
  • Click Next, Next, the radio button for Accept, Finish
  • restart Eclipse when prompted
    
• Install Within Eclipse, install the Subversive Connector
• Again, use  File -> Import -> Maven -> Check out Maven Projects from SCM
• The Install Connectors window will open.
• Select one of them and install it: (On Windows 7 Pro, "Native JavaHL 1.8.14 (64 bit" works
  • Click Finish
  • Accept the install by clicking:  Next, Next, the radio button for Accept, Finish.
• When prompted to restart Eclipse, Click Yes
   
•  You can set your UMLS userID and password to be passed to all Java programs you launch within Eclipse, using Windows->Preferences->Java->Installed JREs->(highlight the JRE you are using)->Edit->Default VM arguments:
             -Dctakes.umlsuser=YourUmlsUserIdGoesHere  "-Dctakes.umlspw=YourUmlsPasswordGoesHere"
• Check out cTAKES:  
• For a third time, Import-> Maven -> Check out Maven Projects from SCM
• For SCM URL, select svn and in the text field enter:  https://svn.apache.org/repos/asf/ctakes/trunk

• Click Finish. Eclipse will download all of the cTAKES sub-projects

  Info
  Due to the way Maven and Eclipse work together you will see two copies of the sub-projects in Eclipse. If you look into your workspace directories there is only one set of underlying files.

   
  

• If you don't have Eclipse set to Build Automatically,  select you'll need perform a build:

  • Select all projects, right click, and choose Maven->Update Projects. Click Select All, and click OK to start the maven build.

  • You can view the Progress pane by using the Eclipse menu option  Window->Show View->Progress

  • Performing a maven build includes running jcasgen as needed. 

• The dictionary for the Fast Dictionary Lookup was downloaded as part of the Maven build.
• If you want to use the full LVG or original dictionary lookup, merge resources from https://sourceforge.net/projects/ctakesresources/files/ctakes-resources-4.0-bin.zip/download into the relevant projectsubproject.
• (Optional) UIMA plug-ins called "UIMA Eclipse tooling and runtime support" can be installed from update site: http://www.apache.org/dist/uima/eclipse-update-site 
  
  
  

...