|
1 |
| -REEF |
2 |
| -==== |
| 1 | +# Apache REEF |
3 | 2 |
|
4 |
| -REEF is the Retainable Evaluator Execution Framework. It makes it easier to write applications on top of resource managers (e.g. YARN). It is released under the Apache 2.0 license. To get started, there is a [Tutorial](https://github.com/Microsoft-CISL/REEF/wiki/How-to-download-and-compile-REEF). We also have a [website](http://www.reef-project.org/) |
| 3 | +REEF (Retainable Evaluator Execution Framework) is a scale-out computing fabric |
| 4 | +that makes it easier to write Big Data applications on top of resource managers |
| 5 | +(e.g., Apache YARN and Mesos). For example, Azure Stream Analytics is built on |
| 6 | +REEF and Hadoop. Apache REEF is currently undergoing incubation at the [Apache |
| 7 | +Software Foundation](http://www.apache.org/). |
5 | 8 |
|
| 9 | +<http://reef.incubator.apache.org/> |
6 | 10 |
|
7 |
| -THIRD PARTY SOFTWARE. |
8 |
| ---------------------- |
9 |
| -This software is built using Maven. Maven allows you to obtain software libraries from other sources as part of the build process. Those libraries are offered and distributed by third parties under their own license terms. Microsoft is not developing, distributing or licensing those libraries to you, but instead, as a convenience, enables you touse this software to obtain those libraries directly from the creators or providers. By using the software, you acknowledge and agree that you are nbtaining the libraries directly from the third parties and under separate license terms, and that it is your responsibility to locate, understand and comply with any such license terms. Microsoft grants you no license rights for third-party software or libraries that are obtained using this software. |
| 11 | +## Online Documentation |
10 | 12 |
|
11 |
| -The list of libraries pulled in this way includes, but is not limited to: |
| 13 | +You can find the latest REEF documentation, including tutorials, on the |
| 14 | +[project web page](http://reef.incubator.apache.org/). This README file |
| 15 | +contains only basic setup instructions. |
12 | 16 |
|
13 |
| - * aopalliance:aopalliance:jar:1.0:compile |
14 |
| - * asm:asm:jar:3.3.1:compile |
15 |
| - * cglib:cglib:jar:2.2.2:compile |
16 |
| - * com.google.guava:guava:jar:15.0:compile |
17 |
| - * com.google.inject:guice:jar:3.0:compile |
18 |
| - * com.google.inject.extensions:guice-servlet:jar:3.0:compile |
19 |
| - * com.google.protobuf:protobuf-java:jar:2.5.0:compile |
20 |
| - * com.jcraft:jsch:jar:0.1.42:compile |
21 |
| - * com.sun.jersey:jersey-client:jar:1.9:compile |
22 |
| - * com.sun.jersey:jersey-core:jar:1.9:compile |
23 |
| - * com.sun.jersey:jersey-grizzly2:jar:1.9:compile |
24 |
| - * com.sun.jersey:jersey-json:jar:1.9:compile |
25 |
| - * com.sun.jersey:jersey-server:jar:1.9:compile |
26 |
| - * com.sun.jersey.contribs:jersey-guice:jar:1.9:compile |
27 |
| - * com.sun.jersey.jersey-test-framework:jersey-test-framework-core:jar:1.9:compile |
28 |
| - * com.sun.jersey.jersey-test-framework:jersey-test-framework-grizzly2:jar:1.9:compile |
29 |
| - * com.sun.xml.bind:jaxb-impl:jar:2.2.3-1:compile |
30 |
| - * com.thoughtworks.paranamer:paranamer:jar:2.3:compile |
31 |
| - * commons-cli:commons-cli:jar:1.2:compile |
32 |
| - * commons-codec:commons-codec:jar:1.4:compile |
33 |
| - * commons-configuration:commons-configuration:jar:1.9:compile |
34 |
| - * commons-el:commons-el:jar:1.0:runtime |
35 |
| - * commons-httpclient:commons-httpclient:jar:3.1:compile |
36 |
| - * commons-io:commons-io:jar:2.1:compile |
37 |
| - * commons-lang:commons-lang:jar:2.6:compile |
38 |
| - * commons-logging:commons-logging:jar:1.1.1:compile |
39 |
| - * commons-net:commons-net:jar:3.1:compile |
40 |
| - * dom4j:dom4j:jar:1.6.1:compile |
41 |
| - * io.netty:netty:jar:3.5.10.Final:compile |
42 |
| - * javax.activation:activation:jar:1.1:compile |
43 |
| - * javax.inject:javax.inject:jar:1:compile |
44 |
| - * javax.servlet:javax.servlet-api:jar:3.0.1:compile |
45 |
| - * javax.servlet:servlet-api:jar:2.5:compile |
46 |
| - * javax.servlet.jsp:jsp-api:jar:2.1:runtime |
47 |
| - * javax.xml.bind:jaxb-api:jar:2.2.2:compile |
48 |
| - * jdk.tools:jdk.tools:jar:1.7:system |
49 |
| - * junit:junit:jar:4.11:test |
50 |
| - * log4j:log4j:jar:1.2.17:compile |
51 |
| - * net.java.dev.jets3t:jets3t:jar:0.6.1:compile |
52 |
| - * org.apache.avro:avro:jar:1.7.4:compile |
53 |
| - * org.apache.commons:commons-compress:jar:1.4.1:compile |
54 |
| - * org.apache.commons:commons-math:jar:2.1:compile |
55 |
| - * org.apache.hadoop:hadoop-annotations:jar:2.2.0:compile |
56 |
| - * org.apache.hadoop:hadoop-auth:jar:2.2.0:compile |
57 |
| - * org.apache.hadoop:hadoop-common:jar:2.2.0:compile |
58 |
| - * org.apache.hadoop:hadoop-yarn-api:jar:2.2.0:compile |
59 |
| - * org.apache.hadoop:hadoop-yarn-client:jar:2.2.0:compile |
60 |
| - * org.apache.hadoop:hadoop-yarn-common:jar:2.2.0:compile |
61 |
| - * org.apache.zookeeper:zookeeper:jar:3.4.5:compile |
62 |
| - * org.codehaus.jackson:jackson-core-asl:jar:1.8.8:compile |
63 |
| - * org.codehaus.jackson:jackson-jaxrs:jar:1.8.3:compile |
64 |
| - * org.codehaus.jackson:jackson-mapper-asl:jar:1.8.8:compile |
65 |
| - * org.codehaus.jackson:jackson-xc:jar:1.8.3:compile |
66 |
| - * org.codehaus.jettison:jettison:jar:1.1:compile |
67 |
| - * org.glassfish:javax.servlet:jar:3.1:compile |
68 |
| - * org.glassfish.external:management-api:jar:3.0.0-b012:compile |
69 |
| - * org.glassfish.gmbal:gmbal-api-only:jar:3.0.0-b023:compile |
70 |
| - * org.glassfish.grizzly:grizzly-framework:jar:2.1.2:compile |
71 |
| - * org.glassfish.grizzly:grizzly-http:jar:2.1.2:compile |
72 |
| - * org.glassfish.grizzly:grizzly-http-server:jar:2.1.2:compile |
73 |
| - * org.glassfish.grizzly:grizzly-http-servlet:jar:2.1.2:compile |
74 |
| - * org.glassfish.grizzly:grizzly-rcm:jar:2.1.2:compile |
75 |
| - * org.hamcrest:hamcrest-core:jar:1.3:test |
76 |
| - * org.javassist:javassist:jar:3.16.1-GA:compile |
77 |
| - * org.mockito:mockito-core:jar:1.9.5:test |
78 |
| - * org.mortbay.jetty:jetty:jar:6.1.26:compile |
79 |
| - * org.mortbay.jetty:jetty-util:jar:6.1.26:compile |
80 |
| - * org.objenesis:objenesis:jar:1.0:test |
81 |
| - * org.reflections:reflections:jar:0.9.9-RC1:compile |
82 |
| - * org.slf4j:slf4j-api:jar:1.7.5:compile |
83 |
| - * org.slf4j:slf4j-log4j12:jar:1.7.5:compile |
84 |
| - * org.tukaani:xz:jar:1.0:compile |
85 |
| - * org.xerial.snappy:snappy-java:jar:1.0.4.1:compile |
86 |
| - * stax:stax-api:jar:1.0.1:compile |
87 |
| - * tomcat:jasper-compiler:jar:5.5.23:runtime |
88 |
| - * tomcat:jasper-runtime:jar:5.5.23:runtime |
89 |
| - * xml-apis:xml-apis:jar:1.0.b2:compile |
90 |
| - * xmlenc:xmlenc:jar:0.52:compile |
| 17 | +## Building REEF |
| 18 | + |
| 19 | +REEF is built using [Apache Maven](http://maven.apache.org/). |
| 20 | +To build REEF and its example programs, run: |
| 21 | + |
| 22 | + mvn -DskipTests clean install |
| 23 | + |
| 24 | +More detailed documentation is available from the project site. |
91 | 25 |
|
92 |
| -An up-to-date list of dependencies pulled in this way can be generated via `mvn dependency:list` on the command line. |
0 commit comments