Changeset 33339 for gs3-extensions

Timestamp:

2019-07-20T23:43:53+12:00 (5 years ago)

Author:

ak19

Message:

Updated README.

File:

• gs3-extensions/maori-lang-detection/README.txt (modified) (1 diff)

gs3-extensions/maori-lang-detection/README.txt

@@ +1 @@
+------------------
+BASIC README
+------------------
+0. The code and its necessary helper files and libraries, and this README, live at:
+    http://trac.greenstone.org/browser/gs3-extensions/maori-lang-detection
+
+You can checkout from svn with:
+    svn co http://svn.greenstone.org/gs3-extensions/maori-lang-detection
+
+- It contains the OpenNLP that was current at the time of the commit, but you can also get it from its original site http://opennlp.apache.org/download.html
+- The LanguageDetectionModel to be used by OpenNLP is also included (again, current at the time of commit), but you can get it from http://opennlp.apache.org/models.html (direct link: https://www.apache.org/dyn/closer.cgi/opennlp/models/langdetect/1.8.3/langdetect-183.bin)
+
+1. Once you've svn checked it out, create a folder called "models" and put the langdetect-183.bin file into it.
+(This is just a zip file, but has to remain with the .bin extension in order for OpenNLP to use it. If you ever wish to see its contents, you can rename to .zip and use the Archive Manager or other Zip tool to inspect the contents.)
+
+2. Next extract the apache-opennlp-1.9.1-bin.tar.gz.
+This will create a folder called apache-opennlp-1.9.1. Move the "models" folder you created in step 1 into this folder.
+
+3. Before you can compile or run the MaoriTextDetector program, you always have to prepare a terminal by setting up the environment for OpenNLP as follows:
+   cd /type/here/path/to/your/extracted/apache-opennlp-1.9.1
+   export OPENNLP_HOME=`pwd`
+
+
+4. If you want to recompile, go up into the checked out maori-lang-detection folder's "src" subfolder. To compile, make sure you have the JDK7+ bin folder on your PATH environment variable.
+Still in the SAME terminal as where you set up the OPENNLP_HOME environment in step 3, you can now run:
+      maori-lang-detection/src$ javac -cp ".:$OPENNLP_HOME/lib/opennlp-tools-1.9.1.jar" MaoriTextDetector.java
+
+5. To run the MaoriTextDetector program, you will need the JDK or JRE 7+ bin folder on your PATH and still in the SAME terminal as where you set up the OPENNLP_HOME environment in step 3,
+type one of the following:
+   maori-lang-detection/src$ java -cp ".:$OPENNLP_HOME/lib/*" MaoriTextDetector --help
+   (prints the usage, including other options)                  
+ 
+   maori-lang-detection/src$ java -cp ".:$OPENNLP_HOME/lib/*" MaoriTextDetector --file <full/path/to/textfile>
+ 
+   maori-lang-detection/src$ java -cp ".:$OPENNLP_HOME/lib/*" MaoriTextDetector -
+       which expects text to stream in from standard input.
+       If entering text manually, then remember to press Ctrl-D to indicate the usual end of StdIn.
+
+
+
+
+For reading materials, see the OLD README section below.
+
+-------------------------
+     OLD README
+-------------------------
+
+
 http://opennlp.apache.org/news/model-langdetect-183.html
 Language Detector Model for Apache OpenNLP released