svn commit: r844134 - in /websites/staging/ctakes/trunk/content: ./ ctakes/3.0.0/user-guide-3.0.html

[bu...@apache.org]

Author: buildbot
Date: Fri Dec 28 16:22:54 2012
New Revision: 844134

Log:
Staging update by buildbot for ctakes

Modified:
    websites/staging/ctakes/trunk/content/   (props changed)
    websites/staging/ctakes/trunk/content/ctakes/3.0.0/user-guide-3.0.html

Propchange: websites/staging/ctakes/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Dec 28 16:22:54 2012
@@ -1 +1 @@
-1417221
+1426567

Modified: websites/staging/ctakes/trunk/content/ctakes/3.0.0/user-guide-3.0.html
==============================================================================
--- websites/staging/ctakes/trunk/content/ctakes/3.0.0/user-guide-3.0.html (original)
+++ websites/staging/ctakes/trunk/content/ctakes/3.0.0/user-guide-3.0.html Fri Dec 28 16:22:54 2012
@@ -85,7 +85,47 @@
   </div>
   <div id="contenta">
     <h1 id="ctakes-30-user-guide">cTAKES 3.0 User Guide</h1>
-<p>Coming soon ...</p>
+<h2 id="requirements">Requirements</h2>
+<p>Java 1.6 or later is required to run cTAKES</p>
+<h2 id="installation">Installation</h2>
+<p>Basic installation:</p>
+<ol>
+<li>Download one of the cTAKES archives</li>
+<li>It is recommended that you verify the downloaded file using signatures downloaded from our main distribution directory (not from one of the mirrors).
+Unpack the archive.</li>
+</ol>
+<p>If you plan to use the full LVG resource (recommended)</p>
+<ol>
+<li>Download either the full version or the lite version from NIH Lexical Tools</li>
+<li>Extract the tgz file that you downloaded to a temporary directory. If you are on Windows, you can use a tool like 7-zip (available online). </li>
+<li>On some operating systems, like Windows, this may need to be done in two steps:
+ 1) to uncompress and 2) to unzip.</li>
+<li>Replace the directory <cTAKES_HOME>/resources/lvgresources/lvg/data/HSqlDb with data/HSqlDb from your extracted download. Replacing the entire directory is appropriate.</li>
+</ol>
+<p>If you plan to use the UMLS resources:</p>
+<ol>
+<li>
+<p>Download and unpack the UMLS resources and add them to the resources directory from 
+http://sourceforge.net/projects/ctakesresources/files/</p>
+</li>
+<li>
+<p>Also either set/export env variables like this</p>
+</li>
+</ol>
+<p>export ctakes.umlsuser=[username], ctakes.umlspw=[password]</p>
+<p>or add the system properties to the java args</p>
+<p>-Dctakes.umlsuser=[username] -Dctakes.umlspw=[password]</p>
+<h2 id="usage">Usage</h2>
+<ol>
+<li>Run bin/runctakesCVD </li>
+<li>Load an AE (analysis engine)</li>
+</ol>
+<p>Select desc/ctakes-clinical-pipeline/desc/analysis_engine/AggregatePlaintextProcessor
+- Enter note or other text
+- Run analysis engine</p>
+<p>NOTE: The included example dictionary is very small. If you did not download the UMLS resource, 
+try a sentence such as: </p>
+<p>Patient took aspirin for knee pain</p>
   </div>
  
  <div id="footera">