svn commit: r1426567 - /incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext

[ja...@apache.org]

Author: james-masanz
Date: Fri Dec 28 16:22:50 2012
New Revision: 1426567

URL: http://svn.apache.org/viewvc?rev=1426567&view=rev
Log:
first pass at some basic user information for 3.0.0

Modified:
    incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext

Modified: incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext
URL: http://svn.apache.org/viewvc/incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext?rev=1426567&r1=1426566&r2=1426567&view=diff
==============================================================================
--- incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext (original)
+++ incubator/ctakes/site/trunk/content/ctakes/3.0.0/user-guide-3.0.mdtext Fri Dec 28 16:22:50 2012
@@ -18,4 +18,49 @@ Notice:    Licensed to the Apache Softwa
 
 #cTAKES 3.0 User Guide
 
-Coming soon ...
\ No newline at end of file
+## Requirements
+Java 1.6 or later is required to run cTAKES
+
+##Installation
+
+Basic installation:
+
+1. Download one of the cTAKES archives
+- 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.
+
+If you plan to use the full LVG resource (recommended)
+
+1. Download either the full version or the lite version from NIH Lexical Tools
+- 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). 
+- On some operating systems, like Windows, this may need to be done in two steps:
+ 1) to uncompress and 2) to unzip.
+- Replace the directory <cTAKES_HOME>/resources/lvgresources/lvg/data/HSqlDb with data/HSqlDb from your extracted download. Replacing the entire directory is appropriate.
+
+If you plan to use the UMLS resources:
+
+1. Download and unpack the UMLS resources and add them to the resources directory from 
+http://sourceforge.net/projects/ctakesresources/files/
+
+- Also either set/export env variables like this
+
+ export ctakes.umlsuser=[username], ctakes.umlspw=[password]
+
+ or add the system properties to the java args
+
+ -Dctakes.umlsuser=[username] -Dctakes.umlspw=[password]
+##Usage
+
+1. Run bin/runctakesCVD 
+- Load an AE (analysis engine)
+
+  Select desc/ctakes-clinical-pipeline/desc/analysis_engine/AggregatePlaintextProcessor
+- Enter note or other text
+- Run analysis engine
+
+ NOTE: The included example dictionary is very small. If you did not download the UMLS resource, 
+try a sentence such as: 
+
+   Patient took aspirin for knee pain
+
+