You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by cw...@apache.org on 2013/10/22 22:00:52 UTC

svn commit: r1534761 - in /uima/sandbox/uima-ducc/trunk: README RELEASE_NOTES.html

Author: cwiklik
Date: Tue Oct 22 20:00:51 2013
New Revision: 1534761

URL: http://svn.apache.org/r1534761
Log:
UIMA-3293 Modified README and added RELEASE_NOTES.html

Added:
    uima/sandbox/uima-ducc/trunk/RELEASE_NOTES.html   (with props)
Modified:
    uima/sandbox/uima-ducc/trunk/README

Modified: uima/sandbox/uima-ducc/trunk/README
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/README?rev=1534761&r1=1534760&r2=1534761&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/README (original)
+++ uima/sandbox/uima-ducc/trunk/README Tue Oct 22 20:00:51 2013
@@ -1,3 +1,142 @@
-              Apache Distributed UIMA Cluster Computing (DUCC) Version 1.0 README
+              Apache Distributed UIMA Cluster Computing (DUCC) Version 0.0.8 README
               
+              
+1. What is DUCC?
+=========================================
+
+DUCC stands for Distributed UIMA Cluster Computing. DUCC is a cluster management system providing tooling,
+management, and scheduling facilities to automate the scale-out of applications written to the UIMA framework.
+Core UIMA provides a generalized framework for applications that process unstructured information such as human
+language, but does not provide a scale-out mechanism. UIMA-AS provides a scale-out mechanism to distribute UIMA
+pipelines over a cluster of computing resources, but does not provide job or cluster management of the resources.
+DUCC defines a formal job model that closely maps to a standard UIMA pipeline. Around this job model DUCC
+provides cluster management services to automate the scale-out of UIMA pipelines over computing clusters.
+
+2. Building from the Source Distribution
+========================================
+     
+We use Maven 3.0 for building; download this if needed, 
+and set the environment variable MAVEN_OPTS to -Xmx800m -XX:MaxPerSize-256m.
+
+Then build from the directory containing this README by issuing the command
+   mvn clean install.
+   
+This builds everything except the ...source-release.zip file. If you want that,
+change the command to 
+
+   mvn clean install -Papache-release
+   
+Look for the result in the two artifacts: 
+   target/uima-ducc-[version]-source-release.zip (if run with -Papache-release) and
+   target/uima-as-[version]-bin.tar.gz
+
+For more details, please see http://uima.apache.org/building-uima.html   
+
+3. What's New in 0.0.8?
+====================== 
+  
+UIMA DUCC 0.0.8 is the first Apache release. For up-to-date information on UIMA-DUCC 
+issues, see our issue tracker: http://issues.apache.org/jira/browse/UIMA/components/12319807
+
+
+4. Contents of Apache UIMA DUCC binary distribution
+--------------------------------------------------
+
+The Apache UIMA DUCC binary distribution includes
+  - Apache UIMA Java SDK version 2.4.2
+  - Apache UIMA Asynchronous Scaleout (AS) version 2.4.2
+  - Saxon
+  - Apache ActiveMQ version 5.6.0
+  - Spring Framework version 3.0.5.RELEASE
+  - Apache Camel version 2.10.1
+  - Apache Mina
+  - Apache Commons CLI version 1.2
+  - Apache Commons Math version 2.0
+  - Apache Commons Lang version 2.6
+  - Apache Commons Collections version 3.2.1
+  - Apache Log4J version 1.2.16
+  - Apache Commons HTTP Client version 3.1
+  - XMLBeans version 2.5.0
+  - XStream version 1.5.0_16
+  - SLF4J version 1.5.11
+  - JUnit version 4.8.2
+  - JODA Time version 1.2
+  - Google Guava version 0.9
+  - Google-Gson version 2.2.2
+  
+  shell scripts:
+  --------------
+
+  admin/start_ducc: starts DUCC
+  admin/stop_ducc: stops DUCC
+  
+
+  documentation:
+  --------------
+ 
+  docs/duccbok.pdf: UIMA-DUCC documentation
+  docs/install.pdf: UIMA-DUCC installation guide
+
+  examples:
+  ---------
+ 
+  examples/ - contains ducc example source code and resources
+  
+  descriptors:
+  ------------
+ 
+  examples/descriptors/ - contains sample descriptor files 
+
+  resources
+  -----------
+  
+  resources/ - contains ducc configuration files
+  
+  
+2. Installation and Setup
+=========================
+
+Please refer to docs/install.pdf for installation instructions.
+
+2.1 Supported Platforms
+-----------------------
+
+UIMA-DUCC Requires Java 6 or later. It has been tested with Sun Java 6 on Linux,
+and with IBM Java 6 on Linux. 
+
+
+3. Known problems/limitations with Release 0.0.8
+================================================
+
+  
+     
+  
+
+Crypto Notice
+-------------
+
+   This distribution includes cryptographic software.  The country in 
+   which you currently reside may have restrictions on the import, 
+   possession, use, and/or re-export to another country, of 
+   encryption software.  BEFORE using any encryption software, please 
+   check your country's laws, regulations and policies concerning the
+   import, possession, or use, and re-export of encryption software, to 
+   see if this is permitted.  See <http://www.wassenaar.org/> for more
+   information.
+
+   The U.S. Government Department of Commerce, Bureau of Industry and
+   Security (BIS), has classified this software as Export Commodity 
+   Control Number (ECCN) 5D002.C.1, which includes information security
+   software using or performing cryptographic functions with asymmetric
+   algorithms.  The form and manner of this Apache Software Foundation
+   distribution makes it eligible for export under the License Exception
+   ENC Technology Software Unrestricted (TSU) exception (see the BIS 
+   Export Administration Regulations, Section 740.13) for both object 
+   code and source code.
+
+   The following provides more details on the included cryptographic
+   software:
+   
+   This distribution includes portions of Apache ActiveMQ, which, in
+   turn, is classified as being controlled under ECCN 5D002.
  
\ No newline at end of file

Added: uima/sandbox/uima-ducc/trunk/RELEASE_NOTES.html
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/RELEASE_NOTES.html?rev=1534761&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/RELEASE_NOTES.html (added)
+++ uima/sandbox/uima-ducc/trunk/RELEASE_NOTES.html Tue Oct 22 20:00:51 2013
@@ -0,0 +1,78 @@
+<html>
+  <!--
+   ***************************************************************
+   * Licensed to the Apache Software Foundation (ASF) under one
+   * or more contributor license agreements.  See the NOTICE file
+   * distributed with this work for additional information
+   * regarding copyright ownership.  The ASF licenses this file
+   * to you under the Apache License, Version 2.0 (the
+   * "License"); you may not use this file except in compliance
+   * with the License.  You may obtain a copy of the License at
+   *
+   *   http://www.apache.org/licenses/LICENSE-2.0
+   * 
+   * Unless required by applicable law or agreed to in writing,
+   * software distributed under the License is distributed on an
+   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   * KIND, either express or implied.  See the License for the
+   * specific language governing permissions and limitations
+   * under the License.
+   ***************************************************************
+   -->
+<head>
+  <title>Apache Distributed UIMA Cluster Computing (DUCC) 0.0.8 Release Notes</title>
+</head>
+<body>
+<h1>Apache UIMA-AS (Unstructured Information Management Architecture - Distributed UIMA Cluster Computing ) v0.0.8 Release Notes</h1>
+
+<h2>Contents</h2>
+<p>
+<a href="#what.is.uima-ducc">1. What is UIMA-DUCC?</a><br/>
+<a href="#major.changes">2. Major Changes in this Release</a><br/>
+<a href="#get.involved">3. How to Get Involved</a><br/>
+<a href="#report.issues">4. How to Report Issues</a><br/>
+<a href="#list.issues">5. List of JIRA Issues Fixed in this Release</a>
+</p>  
+   
+<h2><a name="what.is.uima-ducc">1. What is UIMA-DUCC?</a></h2>
+
+     <p>
+  			DUCC stands for Distributed UIMA Cluster Computing. DUCC is a cluster management system providing tooling,
+management, and scheduling facilities to automate the scale-out of applications written to the UIMA framework.
+Core UIMA provides a generalized framework for applications that process unstructured information such as human
+language, but does not provide a scale-out mechanism. UIMA-AS provides a scale-out mechanism to distribute UIMA
+pipelines over a cluster of computing resources, but does not provide job or cluster management of the resources.
+DUCC defines a formal job model that closely maps to a standard UIMA pipeline. Around this job model DUCC
+provides cluster management services to automate the scale-out of UIMA pipelines over computing clusters.
+
+			</p>
+      
+<h2><a name="major.changes">2. Major Changes in this Release</a></h2>
+<p>
+Please see the <a href="README">README</a> for this information. 
+</p> 
+  
+  
+<h2><a name="get.involved">3. How to Get Involved</a></h2>
+<p>
+The Apache UIMA project really needs and appreciates any contributions, 
+including documentation help, source code and feedback.  If you are interested
+in contributing, please visit 
+<a href="http://uima.apache.org/get-involved.html">
+  http://uima.apache.org/get-involved.html</a>.
+</p>
+  
+<h2><a name="report.issues">4. How to Report Issues</a></h2>
+<p>
+The Apache UIMA project uses JIRA for issue tracking.  Please report any 
+issues you find at 
+<a href="http://issues.apache.org/jira/browse/uima">http://issues.apache.org/jira/browse/uima</a>
+</p>
+  
+<h2><a name="list.issues">5. List of JIRA Issues Fixed in this Release</a></h2>
+
+Click <a href="issuesFixed/jira-report.html">issuesFixed/jira-report.hmtl</a> for the list of 
+issues fixed in this release.
+
+</body>
+</html>
\ No newline at end of file

Propchange: uima/sandbox/uima-ducc/trunk/RELEASE_NOTES.html
------------------------------------------------------------------------------
    svn:executable = *