You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by qu...@apache.org on 2016/07/26 22:31:30 UTC
[46/51] [partial] incubator-quarks-website git commit: from
05ad5e885c21d745f87c23c280f222cbca457b89
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/faq.html
----------------------------------------------------------------------
diff --git a/content/docs/faq.html b/content/docs/faq.html
index d3bedfe..2e72401 100644
--- a/content/docs/faq.html
+++ b/content/docs/faq.html
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>FAQ | Apache Quarks Documentation</title>
+<title>FAQ | Apache Edgent Documentation</title>
<link rel="stylesheet" type="text/css" href="../css/syntax.css">
<link rel="stylesheet" type="text/css" href="../css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">-->
@@ -60,7 +60,7 @@
<span class="icon-bar"></span>
</button>
- <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Quarks Documentation</span></a>
+ <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Edgent Documentation</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
@@ -107,7 +107,7 @@
- <li><a href="http://quarks.incubator.apache.org/javadoc/lastest/index.html" target="_blank">Javadoc</a></li>
+ <li><a href="http://quarks.incubator.apache.org/javadoc/latest/index.html" target="_blank">Javadoc</a></li>
@@ -121,7 +121,7 @@
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Quarks Resources<b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Edgent Resources<b class="caret"></b></a>
<ul class="dropdown-menu">
@@ -156,7 +156,7 @@
<!-- Send feedback function -->
<script>
function SendLinkByMail(href) {
-var subject= "Apache Quarks Documentation feedback";
+var subject= "Apache Edgent Documentation feedback";
var body = "I have some feedback about the FAQ page: ";
body += window.location.href;
body += "";
@@ -257,7 +257,7 @@ window.location.href = uri;
<ul id="mysidebar" class="nav">
- <span class="siteTagline">Quarks</span>
+ <span class="siteTagline">Edgent</span>
<span class="versionTagline">Version 0.3.0</span>
@@ -271,7 +271,7 @@ window.location.href = uri;
- <li><a href="../docs/quarks_index.html">Introduction</a></li>
+ <li><a href="../docs/edgent_index.html">Introduction</a></li>
@@ -298,7 +298,7 @@ window.location.href = uri;
- <li><a href="../docs/quarks-getting-started.html">Getting started guide</a></li>
+ <li><a href="../docs/edgent-getting-started.html">Getting started guide</a></li>
@@ -308,7 +308,7 @@ window.location.href = uri;
- <li><a href="../docs/common-quarks-operations.html">Common operations</a></li>
+ <li><a href="../docs/common-edgent-operations.html">Common operations</a></li>
@@ -319,13 +319,13 @@ window.location.href = uri;
- <li><a href="#">Quarks Cookbook</a>
+ <li><a href="#">Edgent Cookbook</a>
<ul>
- <li><a href="../recipes/recipe_hello_quarks.html">Hello Quarks!</a></li>
+ <li><a href="../recipes/recipe_hello_edgent.html">Hello Edgent!</a></li>
@@ -599,53 +599,53 @@ $('#toc').on('click', 'a', function() {
<a target="_blank" href="https://github.com/apache/incubator-quarks-website/blob/master/site/docs/faq.md" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
- <h2 id="what-is-apache-quarks">What is Apache Quarks?</h2>
+ <h2 id="what-is-apache-edgent">What is Apache Edgent?</h2>
-<p>Quarks provides APIs and a lightweight runtime to analyze streaming data at the edge.</p>
+<p>Edgent provides APIs and a lightweight runtime to analyze streaming data at the edge.</p>
<h2 id="what-do-you-mean-by-the-edge">What do you mean by the edge?</h2>
<p>The edge includes devices, gateways, equipment, vehicles, systems, appliances and sensors of all kinds as part of the Internet of Things.</p>
-<h2 id="how-is-apache-quarks-used">How is Apache Quarks used?</h2>
+<h2 id="how-is-apache-edgent-used">How is Apache Edgent used?</h2>
-<p>Quarks can be used at the edge of the Internet of Things, for example, to analyze data on devices, engines, connected cars, etc. Quarks could be on the device itself, or a gateway device collecting data from local devices. You can write an edge application on Quarks and connect it to a Cloud service, such as the IBM Watson IoT Platform. It can also be used for enterprise data collection and analysis; for example log collectors, application data, and data center analytics.</p>
+<p>Edgent can be used at the edge of the Internet of Things, for example, to analyze data on devices, engines, connected cars, etc. Edgent could be on the device itself, or a gateway device collecting data from local devices. You can write an edge application on Edgent and connect it to a Cloud service, such as the IBM Watson IoT Platform. It can also be used for enterprise data collection and analysis; for example log collectors, application data, and data center analytics.</p>
<h2 id="how-are-applications-developed">How are applications developed?</h2>
<p>Applications are developed using a functional flow API to define operations on data streams that are executed as a graph of "oplets" in a lightweight embeddable runtime. The SDK provides capabilities like windowing, aggregation and connectors with an extensible model for the community to expand its capabilities.</p>
-<h2 id="what-apis-does-apache-quarks-support">What APIs does Apache Quarks support?</h2>
+<h2 id="what-apis-does-apache-edgent-support">What APIs does Apache Edgent support?</h2>
-<p>Currently, Quarks supports APIs for Java and Android. Support for additional languages, such as Python, is likely as more developers get involved. Please consider joining the Quarks open source development community to accelerate the contributions of additional APIs.</p>
+<p>Currently, Edgent supports APIs for Java and Android. Support for additional languages, such as Python, is likely as more developers get involved. Please consider joining the Edgent open source development community to accelerate the contributions of additional APIs.</p>
-<h2 id="what-type-of-analytics-can-be-done-with-apache-quarks">What type of analytics can be done with Apache Quarks?</h2>
+<h2 id="what-type-of-analytics-can-be-done-with-apache-edgent">What type of analytics can be done with Apache Edgent?</h2>
-<p>Quarks provides windowing, aggregation and simple filtering. It uses Apache Common Math to provide simple analytics aimed at device sensors. Quarks is also extensible, so you can call existing libraries from within your Quarks application. In the future, Quarks will include more analytics, either exposing more functionality from Apache Common Math, other libraries or hand-coded analytics.</p>
+<p>Edgent provides windowing, aggregation and simple filtering. It uses Apache Common Math to provide simple analytics aimed at device sensors. Edgent is also extensible, so you can call existing libraries from within your Edgent application. In the future, Edgent will include more analytics, either exposing more functionality from Apache Common Math, other libraries or hand-coded analytics.</p>
-<h2 id="what-connectors-does-apache-quarks-support">What connectors does Apache Quarks support?</h2>
+<h2 id="what-connectors-does-apache-edgent-support">What connectors does Apache Edgent support?</h2>
-<p>Quarks supports connectors for MQTT, HTTP, JDBC, File, Apache Kafka and IBM Watson IoT Platform. Quarks is extensible; you can add the connector of your choice.</p>
+<p>Edgent supports connectors for MQTT, HTTP, JDBC, File, Apache Kafka and IBM Watson IoT Platform. Edgent is extensible; you can add the connector of your choice.</p>
-<h2 id="what-centralized-streaming-analytic-systems-does-apache-quarks-support">What centralized streaming analytic systems does Apache Quarks support?</h2>
+<h2 id="what-centralized-streaming-analytic-systems-does-apache-edgent-support">What centralized streaming analytic systems does Apache Edgent support?</h2>
-<p>Quarks supports open source technology (such as Apache Spark, Apache Storm, Flink and samza), IBM Streams (on-premises or IBM Streaming Analytics on Bluemix), or any custom application of your choice.</p>
+<p>Edgent supports open source technology (such as Apache Spark, Apache Storm, Flink and samza), IBM Streams (on-premises or IBM Streaming Analytics on Bluemix), or any custom application of your choice.</p>
-<h2 id="why-do-i-need-apache-quarks-on-the-edge-rather-than-my-streaming-analytic-system">Why do I need Apache Quarks on the edge, rather than my streaming analytic system?</h2>
+<h2 id="why-do-i-need-apache-edgent-on-the-edge-rather-than-my-streaming-analytic-system">Why do I need Apache Edgent on the edge, rather than my streaming analytic system?</h2>
-<p>Quarks is designed for the edge, rather than a more centralized system. It has a small footprint, suitable for running on devices. Quarks provides simple analytics, allowing a device to analyze data locally and to only send to the centralized system if there is a need, reducing communication costs.</p>
+<p>Edgent is designed for the edge, rather than a more centralized system. It has a small footprint, suitable for running on devices. Edgent provides simple analytics, allowing a device to analyze data locally and to only send to the centralized system if there is a need, reducing communication costs.</p>
-<h2 id="why-do-i-need-apache-quarks-rather-than-coding-the-complete-application-myself">Why do I need Apache Quarks, rather than coding the complete application myself?</h2>
+<h2 id="why-do-i-need-apache-edgent-rather-than-coding-the-complete-application-myself">Why do I need Apache Edgent, rather than coding the complete application myself?</h2>
-<p>Quarks is a tool for edge analytics that allows you to be more productive. Quarks provides a consistent data model (streams and windows) and provides useful functionality, such as aggregations, joins, etc. Using Quarks lets you to take advantage of this functionality, allowing you to focus on your application needs.</p>
+<p>Edgent is a tool for edge analytics that allows you to be more productive. Edgent provides a consistent data model (streams and windows) and provides useful functionality, such as aggregations, joins, etc. Using Edgent lets you to take advantage of this functionality, allowing you to focus on your application needs.</p>
-<h2 id="where-can-i-download-apache-quarks-to-try-it-out">Where can I download Apache Quarks to try it out?</h2>
+<h2 id="where-can-i-download-apache-edgent-to-try-it-out">Where can I download Apache Edgent to try it out?</h2>
-<p>Quarks is migrating from github quarks-edge to Apache. You can download the source from Apache and build it yourself <a href="https://github.com/apache/incubator-quarks">here</a>. You can also find already built pre-Apache releases of Quarks for download <a href="https://github.com/quarks-edge/quarks/releases/latest">here</a>. These releases are not associated with Apache.</p>
+<p>Edgent is migrating from GitHub quarks-edge to Apache. You can download the source from Apache and build it yourself <a href="https://github.com/apache/incubator-quarks">here</a>. You can also find already built pre-Apache releases of Edgent for download <a href="https://github.com/quarks-edge/quarks/releases/latest">here</a>. These releases are not associated with Apache.</p>
<h2 id="how-do-i-get-started">How do I get started?</h2>
-<p>Getting started is simple. Once you have downloaded Quarks, everything you need to know to get up and running, you will find <a href="quarks-getting-started">here</a>. We suggest you also run the <a href="samples">Quarks sample programs</a> to familiarize yourselves with the code base.</p>
+<p>Getting started is simple. Once you have downloaded Edgent, everything you need to know to get up and running, you will find <a href="edgent-getting-started">here</a>. We suggest you also run the <a href="samples">Edgent sample programs</a> to familiarize yourselves with the code base.</p>
<h2 id="how-can-i-get-involved">How can I get involved?</h2>
@@ -653,11 +653,11 @@ $('#toc').on('click', 'a', function() {
<h2 id="how-can-i-contribute-code">How can I contribute code?</h2>
-<p>Just submit a <a href="https://github.com/apache/incubator-quarks">pull request</a> and wait for a committer to review. For more information, visit our <a href="committers">committer page</a> and read <a href="https://github.com/apache/incubator-quarks/blob/master/DEVELOPMENT.md">DEVELOPMENT.md</a> at the top of the code tree.</p>
+<p>Just submit a <a href="https://github.com/apache/incubator-quarks/pulls">pull request</a> and wait for a committer to review. For more information, visit our <a href="committers">committer page</a> and read <a href="https://github.com/apache/incubator-quarks/blob/master/DEVELOPMENT.md">DEVELOPMENT.md</a> at the top of the code tree.</p>
<h2 id="can-i-become-a-committer">Can I become a committer?</h2>
-<p>Read about Quarks committers and how to become a committer <a href="committers">here</a>.</p>
+<p>Read about Edgent committers and how to become a committer <a href="committers">here</a>.</p>
<h2 id="where-can-i-get-the-code">Where can I get the code?</h2>
@@ -665,23 +665,27 @@ $('#toc').on('click', 'a', function() {
<h2 id="can-i-take-a-copy-of-the-code-and-fork-it-for-my-own-use">Can I take a copy of the code and fork it for my own use?</h2>
-<p>Yes. Quarks is available under the Apache 2.0 license which allows you to fork the code. We hope you will contribute your changes back to the Quarks community.</p>
+<p>Yes. Edgent is available under the Apache 2.0 license which allows you to fork the code. We hope you will contribute your changes back to the Edgent community.</p>
<h2 id="how-do-i-suggest-new-features">How do I suggest new features?</h2>
-<p>Click <a href="https://issues.apache.org/jira/browse/QUARKS">Issues</a> to submit requests for new features. You may browse or query the Issues database to see what other members of the Quarks community have already requested.</p>
+<p>Click <a href="https://issues.apache.org/jira/browse/QUARKS">Issues</a> to submit requests for new features. You may browse or query the Issues database to see what other members of the Edgent community have already requested.</p>
<h2 id="how-do-i-submit-bug-reports">How do I submit bug reports?</h2>
<p>Click <a href="https://issues.apache.org/jira/browse/QUARKS">Issues</a> to submit a bug report.</p>
-<h2 id="how-do-i-ask-questions-about-apache-quarks">How do I ask questions about Apache Quarks?</h2>
+<h2 id="how-do-i-ask-questions-about-apache-edgent">How do I ask questions about Apache Edgent?</h2>
-<p>Use <a href="mailto:">site.data.project.user_list</a> to submit questions to the Quarks community.</p>
+<p>Use the <a href="mailto:dev@quarks.incubator.apache.org">dev list</a> to submit questions to the Edgent community.</p>
-<h2 id="why-is-apache-quarks-open-source">Why is Apache Quarks open source?</h2>
+<h2 id="why-is-apache-edgent-open-source">Why is Apache Edgent open source?</h2>
-<p>With the growth of the Internet of Things there is a need to execute analytics at the edge. Quarks was developed to address requirements for analytics at the edge for IoT use cases that were not addressed by central analytic solutions. These capabilities will be useful to many organizations and that the diverse nature of edge devices and use cases is best addressed by an open community. Our goal is to develop a vibrant community of developers and users to expand the capabilities and real-world use of Quarks by companies and individuals to enable edge analytics and further innovation for the IoT space.</p>
+<p>With the growth of the Internet of Things there is a need to execute analytics at the edge. Edgent was developed to address requirements for analytics at the edge for IoT use cases that were not addressed by central analytic solutions. These capabilities will be useful to many organizations and that the diverse nature of edge devices and use cases is best addressed by an open community. Our goal is to develop a vibrant community of developers and users to expand the capabilities and real-world use of Edgent by companies and individuals to enable edge analytics and further innovation for the IoT space.</p>
+
+<h2 id="i-see-references-to-quot-quarks-quot-how-does-it-relate-to-apache-edgent">I see references to "Quarks." How does it relate to Apache Edgent?</h2>
+
+<p>Up until July 2016, Edgent was known as Quarks. Quarks was renamed due to the name not being unique enough. The suitable name search for Edgent is currently in progress at The Apache Software Foundation.</p>
<div class="tags">
@@ -714,14 +718,14 @@ $('#toc').on('click', 'a', function() {
<div class="col-lg-12 footer">
Site last
- generated: Jul 21, 2016 <br/>
+ generated: Jul 26, 2016 <br/>
</div>
</div>
<br/>
<div class="row">
<div class="col-md-12">
- <p class="small">Apache Quarks is an effort undergoing Incubation at The Apache Software
+ <p class="small">Apache Edgent is an effort undergoing Incubation at The Apache Software
Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects
until a further review indicates that the infrastructure, communications, and decision making process
have stabilized in a manner consistent with other successful ASF projects. While incubation status is
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/home.html
----------------------------------------------------------------------
diff --git a/content/docs/home.html b/content/docs/home.html
index b4eb1fd..a70cc37 100644
--- a/content/docs/home.html
+++ b/content/docs/home.html
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="keywords" content="getting_started, ">
-<title> Apache Quarks Documentation | Apache Quarks Documentation</title>
+<title> Apache Edgent Documentation | Apache Edgent Documentation</title>
<link rel="stylesheet" type="text/css" href="../css/syntax.css">
<link rel="stylesheet" type="text/css" href="../css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">-->
@@ -60,7 +60,7 @@
<span class="icon-bar"></span>
</button>
- <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Quarks Documentation</span></a>
+ <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Edgent Documentation</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
@@ -107,7 +107,7 @@
- <li><a href="http://quarks.incubator.apache.org/javadoc/lastest/index.html" target="_blank">Javadoc</a></li>
+ <li><a href="http://quarks.incubator.apache.org/javadoc/latest/index.html" target="_blank">Javadoc</a></li>
@@ -121,7 +121,7 @@
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Quarks Resources<b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Edgent Resources<b class="caret"></b></a>
<ul class="dropdown-menu">
@@ -156,7 +156,7 @@
<!-- Send feedback function -->
<script>
function SendLinkByMail(href) {
-var subject= "Apache Quarks Documentation feedback";
+var subject= "Apache Edgent Documentation feedback";
var body = "I have some feedback about the Introduction page: ";
body += window.location.href;
body += "";
@@ -257,7 +257,7 @@ window.location.href = uri;
<ul id="mysidebar" class="nav">
- <span class="siteTagline">Quarks</span>
+ <span class="siteTagline">Edgent</span>
<span class="versionTagline">Version 0.3.0</span>
@@ -271,7 +271,7 @@ window.location.href = uri;
- <li><a href="../docs/quarks_index.html">Introduction</a></li>
+ <li><a href="../docs/edgent_index.html">Introduction</a></li>
@@ -298,7 +298,7 @@ window.location.href = uri;
- <li><a href="../docs/quarks-getting-started.html">Getting started guide</a></li>
+ <li><a href="../docs/edgent-getting-started.html">Getting started guide</a></li>
@@ -308,7 +308,7 @@ window.location.href = uri;
- <li><a href="../docs/common-quarks-operations.html">Common operations</a></li>
+ <li><a href="../docs/common-edgent-operations.html">Common operations</a></li>
@@ -319,13 +319,13 @@ window.location.href = uri;
- <li><a href="#">Quarks Cookbook</a>
+ <li><a href="#">Edgent Cookbook</a>
<ul>
- <li><a href="../recipes/recipe_hello_quarks.html">Hello Quarks!</a></li>
+ <li><a href="../recipes/recipe_hello_edgent.html">Hello Edgent!</a></li>
@@ -565,7 +565,7 @@ $('#toc').on('click', 'a', function() {
<div class="col-md-9">
<div class="post-header">
- <h1 class="post-title-main"> Apache Quarks Documentation </h1>
+ <h1 class="post-title-main"> Apache Edgent Documentation </h1>
</div>
<div class="post-content">
@@ -599,24 +599,24 @@ $('#toc').on('click', 'a', function() {
<a target="_blank" href="https://github.com/apache/incubator-quarks-website/blob/master/site/docs/home.md" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
- <h2 id="apache-quarks-overview">Apache Quarks overview</h2>
+ <h2 id="apache-edgent-overview">Apache Edgent overview</h2>
<p>Devices and sensors are everywhere, and more are coming online every day. You need a way to analyze all of the data coming from your devices, but it can be expensive to transmit all of the data from a sensor to your central analytics engine.</p>
-<p>Quarks is an open source programming model and runtime for edge devices that enables you to analyze data and events at the device. When you analyze on the edge, you can:</p>
+<p>Edgent is an open source programming model and runtime for edge devices that enables you to analyze data and events at the device. When you analyze on the edge, you can:</p>
<ul>
<li><p>Reduce the amount of data that you transmit to your analytics server</p></li>
<li><p>Reduce the amount of data that you store</p></li>
</ul>
-<p>A Quarks application uses analytics to determine when data needs to be sent to a back-end system for further analysis, action, or storage. For example, you can use Quarks to determine whether a system is running outside of normal parameters, such as an engine that is running too hot.</p>
+<p>An Edgent application uses analytics to determine when data needs to be sent to a back-end system for further analysis, action, or storage. For example, you can use Edgent to determine whether a system is running outside of normal parameters, such as an engine that is running too hot.</p>
-<p>If the system is running normally, you don\u2019t need to send this data to your back-end system; it\u2019s an added cost and an additional load on your system to process and store. However, if Quarks detects an issue, you can transmit that data to your back-end system to determine why the issue is occurring and how to resolve the issue.</p>
+<p>If the system is running normally, you don\u2019t need to send this data to your back-end system; it\u2019s an added cost and an additional load on your system to process and store. However, if Edgent detects an issue, you can transmit that data to your back-end system to determine why the issue is occurring and how to resolve the issue.</p>
-<p>Quarks enables you to shift from sending a continuous flow of trivial data to the server to sending only essential and meaningful data as it occurs. This is especially important when the cost of communication is high, such as when using a cellular network to transmit data, or when bandwidth is limited.</p>
+<p>Edgent enables you to shift from sending a continuous flow of trivial data to the server to sending only essential and meaningful data as it occurs. This is especially important when the cost of communication is high, such as when using a cellular network to transmit data, or when bandwidth is limited.</p>
-<p>The following use cases describe the primary situations in which you would use Quarks:</p>
+<p>The following use cases describe the primary situations in which you would use Edgent:</p>
<ul>
<li><strong>Internet of Things (IoT)</strong>: Analyze data on distributed edge devices and mobile devices to:
@@ -641,7 +641,7 @@ $('#toc').on('click', 'a', function() {
<h3 id="edge-devices-and-back-end-systems">Edge devices and back-end systems</h3>
-<p>You can send data from an Apache Quarks application to your back-end system when you need to perform analysis that cannot be performed on the edge device, such as:</p>
+<p>You can send data from an Apache Edgent application to your back-end system when you need to perform analysis that cannot be performed on the edge device, such as:</p>
<ul>
<li>Running a complex analytic algorithm that requires more resources, such as CPU or memory, than are available on the edge device</li>
@@ -656,7 +656,7 @@ $('#toc').on('click', 'a', function() {
</ul></li>
</ul>
-<p>Quarks communicates with your back-end systems through the following message hubs:</p>
+<p>Edgent communicates with your back-end systems through the following message hubs:</p>
<ul>
<li>MQTT \u2013 The messaging standard for IoT</li>
@@ -719,14 +719,14 @@ $('#toc').on('click', 'a', function() {
<div class="col-lg-12 footer">
Site last
- generated: Jul 21, 2016 <br/>
+ generated: Jul 26, 2016 <br/>
</div>
</div>
<br/>
<div class="row">
<div class="col-md-12">
- <p class="small">Apache Quarks is an effort undergoing Incubation at The Apache Software
+ <p class="small">Apache Edgent is an effort undergoing Incubation at The Apache Software
Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects
until a further review indicates that the infrastructure, communications, and decision making process
have stabilized in a manner consistent with other successful ASF projects. While incubation status is
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/Build_Path_Jars.JPG
----------------------------------------------------------------------
diff --git a/content/docs/images/Build_Path_Jars.JPG b/content/docs/images/Build_Path_Jars.JPG
index 1dc6550..4290ba0 100644
Binary files a/content/docs/images/Build_Path_Jars.JPG and b/content/docs/images/Build_Path_Jars.JPG differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/New_Java_Project.JPG
----------------------------------------------------------------------
diff --git a/content/docs/images/New_Java_Project.JPG b/content/docs/images/New_Java_Project.JPG
index 4004fe7..d80070f 100644
Binary files a/content/docs/images/New_Java_Project.JPG and b/content/docs/images/New_Java_Project.JPG differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/Quickstart_device.png
----------------------------------------------------------------------
diff --git a/content/docs/images/Quickstart_device.png b/content/docs/images/Quickstart_device.png
index 8827fe2..2be96bc 100644
Binary files a/content/docs/images/Quickstart_device.png and b/content/docs/images/Quickstart_device.png differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/console_hover_over_link.jpg
----------------------------------------------------------------------
diff --git a/content/docs/images/console_hover_over_link.jpg b/content/docs/images/console_hover_over_link.jpg
index 865162f..cb813a9 100644
Binary files a/content/docs/images/console_hover_over_link.jpg and b/content/docs/images/console_hover_over_link.jpg differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/console_hover_over_op.jpg
----------------------------------------------------------------------
diff --git a/content/docs/images/console_hover_over_op.jpg b/content/docs/images/console_hover_over_op.jpg
index 3f83c03..759f6c7 100644
Binary files a/content/docs/images/console_hover_over_op.jpg and b/content/docs/images/console_hover_over_op.jpg differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/console_oplet_kind.jpg
----------------------------------------------------------------------
diff --git a/content/docs/images/console_oplet_kind.jpg b/content/docs/images/console_oplet_kind.jpg
index 0e9e132..592aa9c 100644
Binary files a/content/docs/images/console_oplet_kind.jpg and b/content/docs/images/console_oplet_kind.jpg differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/console_oplet_properties.jpg
----------------------------------------------------------------------
diff --git a/content/docs/images/console_oplet_properties.jpg b/content/docs/images/console_oplet_properties.jpg
index c080a22..32a9562 100644
Binary files a/content/docs/images/console_oplet_properties.jpg and b/content/docs/images/console_oplet_properties.jpg differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/console_overview.jpg
----------------------------------------------------------------------
diff --git a/content/docs/images/console_overview.jpg b/content/docs/images/console_overview.jpg
index 47f1b7a..ade8e35 100644
Binary files a/content/docs/images/console_overview.jpg and b/content/docs/images/console_overview.jpg differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/console_top_controls.jpg
----------------------------------------------------------------------
diff --git a/content/docs/images/console_top_controls.jpg b/content/docs/images/console_top_controls.jpg
index 82222dc..9f15071 100644
Binary files a/content/docs/images/console_top_controls.jpg and b/content/docs/images/console_top_controls.jpg differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/images/console_tuple_count.jpg
----------------------------------------------------------------------
diff --git a/content/docs/images/console_tuple_count.jpg b/content/docs/images/console_tuple_count.jpg
index 01efb27..c3199cf 100644
Binary files a/content/docs/images/console_tuple_count.jpg and b/content/docs/images/console_tuple_count.jpg differ
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/overview.html
----------------------------------------------------------------------
diff --git a/content/docs/overview.html b/content/docs/overview.html
index bfa023c..4740e87 100644
--- a/content/docs/overview.html
+++ b/content/docs/overview.html
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Overview | Apache Quarks Documentation</title>
+<title>Overview | Apache Edgent Documentation</title>
<link rel="stylesheet" type="text/css" href="../css/syntax.css">
<link rel="stylesheet" type="text/css" href="../css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">-->
@@ -60,7 +60,7 @@
<span class="icon-bar"></span>
</button>
- <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Quarks Documentation</span></a>
+ <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Edgent Documentation</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
@@ -107,7 +107,7 @@
- <li><a href="http://quarks.incubator.apache.org/javadoc/lastest/index.html" target="_blank">Javadoc</a></li>
+ <li><a href="http://quarks.incubator.apache.org/javadoc/latest/index.html" target="_blank">Javadoc</a></li>
@@ -121,7 +121,7 @@
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Quarks Resources<b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Edgent Resources<b class="caret"></b></a>
<ul class="dropdown-menu">
@@ -156,7 +156,7 @@
<!-- Send feedback function -->
<script>
function SendLinkByMail(href) {
-var subject= "Apache Quarks Documentation feedback";
+var subject= "Apache Edgent Documentation feedback";
var body = "I have some feedback about the Overview page: ";
body += window.location.href;
body += "";
@@ -257,7 +257,7 @@ window.location.href = uri;
<ul id="mysidebar" class="nav">
- <span class="siteTagline">Quarks</span>
+ <span class="siteTagline">Edgent</span>
<span class="versionTagline">Version 0.3.0</span>
@@ -271,7 +271,7 @@ window.location.href = uri;
- <li><a href="../docs/quarks_index.html">Introduction</a></li>
+ <li><a href="../docs/edgent_index.html">Introduction</a></li>
@@ -298,7 +298,7 @@ window.location.href = uri;
- <li><a href="../docs/quarks-getting-started.html">Getting started guide</a></li>
+ <li><a href="../docs/edgent-getting-started.html">Getting started guide</a></li>
@@ -308,7 +308,7 @@ window.location.href = uri;
- <li><a href="../docs/common-quarks-operations.html">Common operations</a></li>
+ <li><a href="../docs/common-edgent-operations.html">Common operations</a></li>
@@ -319,13 +319,13 @@ window.location.href = uri;
- <li><a href="#">Quarks Cookbook</a>
+ <li><a href="#">Edgent Cookbook</a>
<ul>
- <li><a href="../recipes/recipe_hello_quarks.html">Hello Quarks!</a></li>
+ <li><a href="../recipes/recipe_hello_edgent.html">Hello Edgent!</a></li>
@@ -599,24 +599,24 @@ $('#toc').on('click', 'a', function() {
<a target="_blank" href="https://github.com/apache/incubator-quarks-website/blob/master/site/docs/overview.md" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
- <h1 id="apache-quarks-overview">Apache Quarks Overview</h1>
+ <h1 id="apache-edgent-overview">Apache Edgent Overview</h1>
<p>Devices and sensors are everywhere, and more are coming online every day. You need a way to analyze all of the data coming from your devices, but it can be expensive to transmit all of the data from a sensor to your central analytics engine.</p>
-<p>Apache Quarks is an open source programming model and runtime for edge devices that enables you to analyze data and events at the device. When you analyze on the edge, you can:</p>
+<p>Apache Edgent is an open source programming model and runtime for edge devices that enables you to analyze data and events at the device. When you analyze on the edge, you can:</p>
<ul>
<li><p>Reduce the amount of data that you transmit to your analytics server</p></li>
<li><p>Reduce the amount of data that you store</p></li>
</ul>
-<p>A Quarks application uses analytics to determine when data needs to be sent to a back-end system for further analysis, action, or storage. For example, you can use Quarks to determine whether a system is running outside of normal parameters, such as an engine that is running too hot.</p>
+<p>An Edgent application uses analytics to determine when data needs to be sent to a back-end system for further analysis, action, or storage. For example, you can use Edgent to determine whether a system is running outside of normal parameters, such as an engine that is running too hot.</p>
-<p>If the system is running normally, you don\u2019t need to send this data to your back-end system; it\u2019s an added cost and an additional load on your system to process and store. However, if Quarks detects an issue, you can transmit that data to your back-end system to determine why the issue is occurring and how to resolve the issue. </p>
+<p>If the system is running normally, you don\u2019t need to send this data to your back-end system; it\u2019s an added cost and an additional load on your system to process and store. However, if Edgent detects an issue, you can transmit that data to your back-end system to determine why the issue is occurring and how to resolve the issue. </p>
-<p>Quarks enables you to shift from sending a continuous flow of trivial data to the server to sending only essential and meaningful data as it occurs. This is especially important when the cost of communication is high, such as when using a cellular network to transmit data, or when bandwidth is limited.</p>
+<p>Edgent enables you to shift from sending a continuous flow of trivial data to the server to sending only essential and meaningful data as it occurs. This is especially important when the cost of communication is high, such as when using a cellular network to transmit data, or when bandwidth is limited.</p>
-<p>The following use cases describe the primary situations in which you would use Quarks:</p>
+<p>The following use cases describe the primary situations in which you would use Edgent:</p>
<ul>
<li><em>Internet of Things (IoT):</em> Analyze data on distributed edge devices and mobile devices to:
@@ -641,7 +641,7 @@ $('#toc').on('click', 'a', function() {
<h2 id="edge-devices-and-back-end-systems">Edge devices and back-end systems</h2>
-<p>You can send data from a Quarks application to your back-end system when you need to perform analysis that cannot be performed on the edge device, such as:</p>
+<p>You can send data from an Edgent application to your back-end system when you need to perform analysis that cannot be performed on the edge device, such as:</p>
<ul>
<li>Running a complex analytic algorithm that requires more resources, such as CPU or memory, than are available on the edge device.</li>
@@ -657,7 +657,7 @@ medical device.</li>
</ul></li>
</ul>
-<p>Quarks communicates with your back-end systems through the following message hubs:</p>
+<p>Edgent communicates with your back-end systems through the following message hubs:</p>
<ul>
<li>MQTT \u2013 The messaging standard for IoT</li>
@@ -704,14 +704,14 @@ medical device.</li>
<div class="col-lg-12 footer">
Site last
- generated: Jul 21, 2016 <br/>
+ generated: Jul 26, 2016 <br/>
</div>
</div>
<br/>
<div class="row">
<div class="col-md-12">
- <p class="small">Apache Quarks is an effort undergoing Incubation at The Apache Software
+ <p class="small">Apache Edgent is an effort undergoing Incubation at The Apache Software
Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects
until a further review indicates that the infrastructure, communications, and decision making process
have stabilized in a manner consistent with other successful ASF projects. While incubation status is
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/quarks-getting-started.html
----------------------------------------------------------------------
diff --git a/content/docs/quarks-getting-started.html b/content/docs/quarks-getting-started.html
deleted file mode 100644
index e4d9dec..0000000
--- a/content/docs/quarks-getting-started.html
+++ /dev/null
@@ -1,840 +0,0 @@
-<!DOCTYPE html>
- <head>
-
- <meta charset="utf-8">
-<meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta name="viewport" content="width=device-width, initial-scale=1">
-<meta name="description" content="">
-<meta name="keywords" content=" ">
-<title>Getting started with Apache Quarks | Apache Quarks Documentation</title>
-<link rel="stylesheet" type="text/css" href="../css/syntax.css">
-<link rel="stylesheet" type="text/css" href="../css/font-awesome.min.css">
-<!--<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">-->
-<link rel="stylesheet" type="text/css" href="../css/modern-business.css">
-<link rel="stylesheet" type="text/css" href="../css/lavish-bootstrap.css">
-<link rel="stylesheet" type="text/css" href="../css/customstyles.css">
-<link rel="stylesheet" type="text/css" href="../css/theme-blue.css">
-<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
-<script src="../js/jquery.navgoco.min.js"></script>
-<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
-<script src="../js/toc.js"></script>
-<script src="../js/customscripts.js"></script>
-<link rel="shortcut icon" href="../common_images/favicon.ico" type="image/x-icon">
-<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
-<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
-<!--[if lt IE 9]>
-<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
-<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
-<![endif]-->
-
-
-
-
-
-
-
-
-
-<script>
- $(function () {
- $('[data-toggle="tooltip"]').tooltip()
- })
-</script>
-
-
-
- </head>
-
-<body>
-
- <!-- Navigation -->
-<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
- <div class="container topnavlinks">
- <div class="navbar-header">
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Quarks Documentation</span></a>
-
- </div>
- <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
- <ul class="nav navbar-nav navbar-right">
- <!-- entries without drop-downs appear here -->
- <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
-
-
-
-
-
-
-
-
-
- <li class="dropdown">
-
-
-
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">GitHub Repos<b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
- <li><a href="https://github.com/apache/incubator-quarks" target="_blank">Source code</a></li>
-
-
-
-
-
- <li><a href="https://github.com/apache/incubator-quarks-website" target="_blank">Website/Documentation</a></li>
-
-
-
-
-
- </ul>
- </li>
-
-
-
-
-
-
-
-
- <li><a href="http://quarks.incubator.apache.org/javadoc/lastest/index.html" target="_blank">Javadoc</a></li>
-
-
-
-
-
-
- <!-- entries with drop-downs appear here -->
- <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
-
- <li class="dropdown">
-
-
-
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Quarks Resources<b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
- <li><a href="https://github.com/apache/incubator-quarks/releases" target="_blank">Download</a></li>
-
-
-
-
-
- <li><a href="samples">Samples</a></li>
-
-
-
-
-
- <li><a href="faq">FAQ</a></li>
-
-
-
-
-
- </ul>
- </li>
-
-
-
-
- <!-- special insertion -->
-
-
- <!-- Send feedback function -->
-<script>
-function SendLinkByMail(href) {
-var subject= "Apache Quarks Documentation feedback";
-var body = "I have some feedback about the Getting started with Apache Quarks page: ";
-body += window.location.href;
-body += "";
-var uri = "mailto:?subject=";
-uri += encodeURIComponent(subject);
-uri += "&body=";
-uri += encodeURIComponent(body);
-window.location.href = uri;
-}
-</script>
-
-<li><a href="mailto:dev@quarks.incubator.apache.org" target="_blank"><i class="fa fa-envelope-o"></i> Feedback</a></li>
-
-
- <!--uncomment this block if you want simple search instead of algolia-->
- <li>
- <!--start search-->
- <div id="search-demo-container">
- <input type="text" id="search-input" placeholder="search...">
- <ul id="results-container"></ul>
- </div>
- <script src="../js/jekyll-search.js" type="text/javascript"></script>
- <script type="text/javascript">
- SimpleJekyllSearch.init({
- searchInput: document.getElementById('search-input'),
- resultsContainer: document.getElementById('results-container'),
- dataSource: '../search.json',
- searchResultTemplate: '<li><a href="{url}" title="Getting started with Apache Quarks">{title}</a></li>',
- noResultsText: 'No results found.',
- limit: 10,
- fuzzy: true,
- })
- </script>
- <!--end search-->
- </li>
-
-
- </div>
- <!-- /.container -->
-</nav>
-
-
-
- <!-- Page Content -->
- <div class="container">
- <div class="col-lg-12"> </div>
-
-
-<!-- Content Row -->
-<div class="row">
- <!-- Sidebar Column -->
- <div class="col-md-3">
-
- <script>
-
- $(document).ready(function() {
- // Initialize navgoco with default options
- $("#mysidebar").navgoco({
- caretHtml: '',
- accordion: true,
- openClass: 'active', // open
- save: true,
- cookie: {
- name: 'navgoco',
- expires: false,
- path: '/'
- },
- slide: {
- duration: 400,
- easing: 'swing'
- }
- });
-
- $("#collapseAll").click(function(e) {
- e.preventDefault();
- $("#mysidebar").navgoco('toggle', false);
- });
-
- $("#expandAll").click(function(e) {
- e.preventDefault();
- $("#mysidebar").navgoco('toggle', true);
- });
-
- });
-
- </script>
-
-
-
-
-
-
-
-
-
-
-
-
- <ul id="mysidebar" class="nav">
-
- <span class="siteTagline">Quarks</span>
- <span class="versionTagline">Version 0.3.0</span>
-
-
-
-
-
-
- <li><a href="#">Overview</a>
- <ul>
-
-
-
-
- <li><a href="../docs/quarks_index.html">Introduction</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../docs/faq.html">FAQ</a></li>
-
-
-
-
-
-
- </ul>
-
-
-
- <li><a href="#">Get Started</a>
- <ul>
-
-
-
-
- <li class="active"><a href="../docs/quarks-getting-started.html">Getting started guide</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../docs/common-quarks-operations.html">Common operations</a></li>
-
-
-
-
-
-
- </ul>
-
-
-
- <li><a href="#">Quarks Cookbook</a>
- <ul>
-
-
-
-
- <li><a href="../recipes/recipe_hello_quarks.html">Hello Quarks!</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_source_function.html">Writing a source function</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_value_out_of_range.html">Detecting a sensor value out of expected range</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_different_processing_against_stream.html">Applying different processing against a single stream</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_combining_streams_processing_results.html">Splitting a stream to apply different processing and combining the results into a single stream</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_external_filter_range.html">Using an external configuration file for filter ranges</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_adaptable_filter_range.html">Changing a filter's range</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_adaptable_polling_source.html">Changing a polled source stream's period</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_adaptable_deadtime_filter.html">Using an adaptable deadtime filter</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_dynamic_analytic_control.html">Dynamically enabling analytic flows</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_parallel_analytics.html">How can I run analytics on several tuples in parallel?</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../recipes/recipe_concurrent_analytics.html">How can I run several analytics on a tuple concurrently?</a></li>
-
-
-
-
-
-
- </ul>
-
-
-
- <li><a href="#">Sample Programs</a>
- <ul>
-
-
-
-
- <li><a href="../docs/samples.html">Samples</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../docs/quickstart.html">Quickstart IBM Watson IoT Platform</a></li>
-
-
-
-
-
-
- </ul>
-
-
-
- <li><a href="#">Using the Console</a>
- <ul>
-
-
-
-
- <li><a href="../docs/console.html">Using the console</a></li>
-
-
-
-
-
-
- </ul>
-
-
-
- <li><a href="#">Get Involved</a>
- <ul>
-
-
-
-
- <li><a href="../docs/community.html">How to participate</a></li>
-
-
-
-
-
-
-
-
-
- <li><a href="../docs/committers.html">Committers</a></li>
-
-
-
-
-
-
- </ul>
-
-
-
-
-
- <!-- if you aren't using the accordion, uncomment this block:
-
- <p class="external">
- <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
- </p>
- -->
- <br/>
- </li>
- </ul>
- <div class="row">
- <div class="col-md-12">
-
-<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
-<script>
-$( document ).ready(function() {
- // Handler for .ready() called.
-
-$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
-
-/* this offset helps account for the space taken up by the floating toolbar. */
-$('#toc').on('click', 'a', function() {
- var target = $(this.getAttribute('href'))
- , scroll_target = target.offset().top
-
- $(window).scrollTop(scroll_target - 10);
- return false
-})
-
-});
-</script>
-
-
-<div id="toc"></div>
-
- </div>
- </div>
- </div>
-
- <!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
- <script>$("li.active").parents('li').toggleClass("active");</script>
-
-
- <!-- Content Column -->
- <div class="col-md-9">
-
- <div class="post-header">
- <h1 class="post-title-main">Getting started with Apache Quarks</h1>
-</div>
-
-<div class="post-content">
-
-
-
-<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
-<script>
-$( document ).ready(function() {
- // Handler for .ready() called.
-
-$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
-
-/* this offset helps account for the space taken up by the floating toolbar. */
-$('#toc').on('click', 'a', function() {
- var target = $(this.getAttribute('href'))
- , scroll_target = target.offset().top
-
- $(window).scrollTop(scroll_target - 10);
- return false
-})
-
-});
-</script>
-
-
-<div id="toc"></div>
-
-
-
-
- <a target="_blank" href="https://github.com/apache/incubator-quarks-website/blob/master/site/docs/quarks-getting-started.md" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
-
- <h2 id="what-is-apache-quarks">What is Apache Quarks?</h2>
-
-<p>Quarks is an open source programming model and runtime for edge devices that enables you to analyze streaming data on your edge devices. When you analyze on the edge, you can:</p>
-
-<ul>
-<li>Reduce the amount of data that you transmit to your analytics server</li>
-<li>Reduce the amount of data that you store</li>
-</ul>
-
-<p>For more information, see the <a href="home">Quarks overview</a>.</p>
-
-<h3 id="apache-quarks-and-streaming-analytics">Apache Quarks and streaming analytics</h3>
-
-<p>The fundamental building block of a Quarks application is a <strong>stream</strong>: a continuous sequence of tuples (messages, events, sensor readings, and so on).</p>
-
-<p>The Quarks API provides the ability to process or analyze each tuple as it appears on a stream, resulting in a derived stream.</p>
-
-<p>Source streams are streams that originate data for analysis, such as readings from a device's temperature sensor.</p>
-
-<p>Streams are terminated using sink functions that can perform local device control or send information to centralized analytic systems through a message hub.</p>
-
-<p>Quarks' primary API is functional where streams are sourced, transformed, analyzed or sinked though functions, typically represented as lambda expressions, such as <code>reading -> reading < 50 || reading > 80</code> to filter temperature readings in Fahrenheit.</p>
-
-<h3 id="downloading-apache-quarks">Downloading Apache Quarks</h3>
-
-<p>To use Quarks, access the source code and build it. You can read more about building Quarks <a href="https://github.com/apache/incubator-quarks/blob/master/DEVELOPMENT.md">here</a>.</p>
-
-<p>After you build the Quarks package, you can set up your environment.</p>
-
-<h3 id="setting-up-your-environment">Setting up your environment</h3>
-
-<p>Ensure that you are running a supported environment. For more information, see the <a href="home">Quarks overview</a>. This guide assumes you're running Java 8.</p>
-
-<p>The Quarks Java 8 JAR files are located in the <code>quarks/java8/lib</code> directory.</p>
-
-<ol>
-<li><p>Create a new Java project in Eclipse, and specify Java 8 as the execution environment JRE:</p>
-
-<p><img src="images/New_Java_Project.JPG" style="width:462px;height:582px;"></p></li>
-<li><p>Modify the Java build path to include all of the JAR files in the <code>quarks\java8\lib</code> directory:</p>
-
-<p><img src="images/Build_Path_Jars.JPG" style="width:661px;height:444px;"></p></li>
-</ol>
-
-<p>Your environment is set up! You can start writing your first Quarks application.</p>
-
-<h2 id="creating-a-simple-application">Creating a simple application</h2>
-
-<p>If you're new to Quarks or to writing streaming applications, the best way to get started is to write a simple program.</p>
-
-<p>Quarks is a framework that pushes data analytics and machine learning to <em>edge devices</em>. (Edge devices include things like routers, gateways, machines, equipment, sensors, appliances, or vehicles that are connected to a network.) Quarks enables you to process data locally—such as, in a car engine, on an Android phone, or Raspberry Pi—before you send data over a network.</p>
-
-<p>For example, if your device takes temperature readings from a sensor 1,000 times per second, it is more efficient to process the data locally and send only interesting or unexpected results over the network. To simulate this, let's define a (simulated) TempSensor class:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kn">import</span> <span class="nn">java.util.Random</span><span class="o">;</span>
-
-<span class="kn">import</span> <span class="nn">quarks.function.Supplier</span><span class="o">;</span>
-
-<span class="cm">/**
- * Every time get() is called, TempSensor generates a temperature reading.
- */</span>
-<span class="kd">public</span> <span class="kd">class</span> <span class="nc">TempSensor</span> <span class="kd">implements</span> <span class="n">Supplier</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="o">{</span>
- <span class="kt">double</span> <span class="n">currentTemp</span> <span class="o">=</span> <span class="mf">65.0</span><span class="o">;</span>
- <span class="n">Random</span> <span class="n">rand</span><span class="o">;</span>
-
- <span class="n">TempSensor</span><span class="o">(){</span>
- <span class="n">rand</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Random</span><span class="o">();</span>
- <span class="o">}</span>
-
- <span class="nd">@Override</span>
- <span class="kd">public</span> <span class="n">Double</span> <span class="n">get</span><span class="o">()</span> <span class="o">{</span>
- <span class="c1">// Change the current temperature some random amount</span>
- <span class="kt">double</span> <span class="n">newTemp</span> <span class="o">=</span> <span class="n">rand</span><span class="o">.</span><span class="na">nextGaussian</span><span class="o">()</span> <span class="o">+</span> <span class="n">currentTemp</span><span class="o">;</span>
- <span class="n">currentTemp</span> <span class="o">=</span> <span class="n">newTemp</span><span class="o">;</span>
- <span class="k">return</span> <span class="n">currentTemp</span><span class="o">;</span>
- <span class="o">}</span>
-<span class="o">}</span>
-</code></pre></div>
-<p>Every time you call <code>TempSensor.get()</code>, it returns a new temperature reading. The continuous temperature readings are a stream of data that a Quarks application can process.</p>
-
-<p>Our sample Quarks application processes this stream by filtering the data and printing the results. Let's define a TempSensorApplication class for the application:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kn">import</span> <span class="nn">java.util.concurrent.TimeUnit</span><span class="o">;</span>
-
-<span class="kn">import</span> <span class="nn">quarks.providers.direct.DirectProvider</span><span class="o">;</span>
-<span class="kn">import</span> <span class="nn">quarks.topology.TStream</span><span class="o">;</span>
-<span class="kn">import</span> <span class="nn">quarks.topology.Topology</span><span class="o">;</span>
-
-<span class="kd">public</span> <span class="kd">class</span> <span class="nc">TempSensorApplication</span> <span class="o">{</span>
- <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="n">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
- <span class="n">TempSensor</span> <span class="n">sensor</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TempSensor</span><span class="o">();</span>
- <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span>
- <span class="n">Topology</span> <span class="n">topology</span> <span class="o">=</span> <span class="n">dp</span><span class="o">.</span><span class="na">newTopology</span><span class="o">();</span>
- <span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="n">tempReadings</span> <span class="o">=</span> <span class="n">topology</span><span class="o">.</span><span class="na">poll</span><span class="o">(</span><span class="n">sensor</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">TimeUnit</span><span class="o">.</span><span class="na">MILLISECONDS</span><span class="o">);</span>
- <span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="n">filteredReadings</span> <span class="o">=</span> <span class="n">tempReadings</span><span class="o">.</span><span class="na">filter</span><span class="o">(</span><span class="n">reading</span> <span class="o">-></span> <span class="n">reading</span> <span class="o"><</span> <span class="mi">50</span> <span class="o">||</span> <span class="n">reading</span> <span class="o">></span> <span class="mi">80</span><span class="o">);</span>
-
- <span class="n">filteredReadings</span><span class="o">.</span><span class="na">print</span><span class="o">();</span>
- <span class="n">dp</span><span class="o">.</span><span class="na">submit</span><span class="o">(</span><span class="n">topology</span><span class="o">);</span>
- <span class="o">}</span>
-<span class="o">}</span>
-</code></pre></div>
-<p>To understand how the application processes the stream, let's review each line.</p>
-
-<h3 id="specifying-a-provider">Specifying a provider</h3>
-
-<p>Your first step when you write a Quarks application is to create a <a href="http://quarks.incubator.apache.org/javadoc/lastest/index.html?quarks/providers/direct/DirectProvider.html"><code>DirectProvider</code></a>:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span>
-</code></pre></div>
-<p>A <code>Provider</code> is an object that contains information on how and where your Quarks application will run. A <code>DirectProvider</code> is a type of Provider that runs your application directly within the current virtual machine when its <code>submit()</code> method is called.</p>
-
-<h3 id="creating-a-topology">Creating a topology</h3>
-
-<p>Additionally a Provider is used to create a <a href="http://quarks.incubator.apache.org/javadoc/lastest/index.html?quarks/topology/Topology.html"><code>Topology</code></a> instance:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">Topology</span> <span class="n">topology</span> <span class="o">=</span> <span class="n">dp</span><span class="o">.</span><span class="na">newTopology</span><span class="o">();</span>
-</code></pre></div>
-<p>In Quarks, <code>Topology</code> is a container that describes the structure of your application:</p>
-
-<ul>
-<li>Where the streams in the application come from</li>
-<li>How the data in the stream is modified</li>
-</ul>
-
-<p>In the TempSensor application above, we have exactly one data source: the <code>TempSensor</code> object. We define the source stream by calling <code>topology.poll()</code>, which takes both a <code>Supplier</code> function and a time parameter to indicate how frequently readings should be taken. In our case, we read from the sensor every millisecond:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="n">tempReadings</span> <span class="o">=</span> <span class="n">topology</span><span class="o">.</span><span class="na">poll</span><span class="o">(</span><span class="n">sensor</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">TimeUnit</span><span class="o">.</span><span class="na">MILLISECONDS</span><span class="o">);</span>
-</code></pre></div>
-<h3 id="defining-the-tstream-object">Defining the <code>TStream</code> object</h3>
-
-<p>Calling <code>topology.poll()</code> to define a source stream creates a <code>TStream<Double></code> instance, which represents the series of readings taken from the temperature sensor.</p>
-
-<p>A streaming application can run indefinitely, so the <code>TStream</code> might see an arbitrarily large number of readings pass through it. Because a <code>TStream</code> represents the flow of your data, it supports a number of operations which allow you to modify your data.</p>
-
-<h3 id="filtering-a-tstream">Filtering a <code>TStream</code></h3>
-
-<p>In our example, we want to filter the stream of temperature readings, and remove any "uninteresting" or expected readings—specifically readings which are above 50 degrees and below 80 degrees. To do this, we call the <code>TStream</code>'s <code>filter</code> method and pass in a function that returns <em>true</em> if the data is interesting and <em>false</em> if the data is uninteresting:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="n">filteredReadings</span> <span class="o">=</span> <span class="n">tempReadings</span><span class="o">.</span><span class="na">filter</span><span class="o">(</span><span class="n">reading</span> <span class="o">-></span> <span class="n">reading</span> <span class="o"><</span> <span class="mi">50</span> <span class="o">||</span> <span class="n">reading</span> <span class="o">></span> <span class="mi">80</span><span class="o">);</span>
-</code></pre></div>
-<p>As you can see, the function that is passed to <code>filter</code> operates on each tuple individually. Unlike data streaming frameworks like <a href="https://spark.apache.org/">Apache Spark</a>, which operate on a collection of data in batch mode, Quarks achieves low latency processing by manipulating each piece of data as soon as it becomes available. Filtering a <code>TStream</code> produces another <code>TStream</code> that contains only the filtered tuples; for example, the <code>filteredReadings</code> stream.</p>
-
-<h3 id="printing-to-output">Printing to output</h3>
-
-<p>When our application detects interesting data (data outside of the expected parameters), we want to print results. You can do this by calling the <code>TStream.print()</code> method, which prints using <code>.toString()</code> on each tuple that passes through the stream:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">filteredReadings</span><span class="o">.</span><span class="na">print</span><span class="o">();</span>
-</code></pre></div>
-<p>Unlike <code>TStream.filter()</code>, <code>TStream.print()</code> does not produce another <code>TStream</code>. This is because <code>TStream.print()</code> is a <strong>sink</strong>, which represents the terminus of a stream.</p>
-
-<p>In addition to <code>TStream.print()</code> there are other sink operations that send tuples to an MQTT server, JDBC connection, file, or Kafka cluster. Additionally, you can define your own sink by invoking <code>TStream.sink()</code> and passing in your own function.</p>
-
-<h3 id="submitting-your-application">Submitting your application</h3>
-
-<p>Now that your application has been completely declared, the final step is to run your application.</p>
-
-<p><code>DirectProvider</code> contains a <code>submit()</code> method, which runs your application directly within the current virtual machine:</p>
-<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">dp</span><span class="o">.</span><span class="na">submit</span><span class="o">(</span><span class="n">topology</span><span class="o">);</span>
-</code></pre></div>
-<p>After you run your program, you should see output containing only "interesting" data coming from your sensor:</p>
-<div class="highlight"><pre><code class="language-" data-lang="">49.904032311772596
-47.97837504039084
-46.59272336309031
-46.681544551652934
-47.400819234155236
-...
-</code></pre></div>
-<p>As you can see, all temperatures are outside the 50-80 degree range. In terms of a real-world application, this would prevent a device from sending superfluous data over a network, thereby reducing communication costs.</p>
-
-<h2 id="further-examples">Further examples</h2>
-
-<p>This example demonstrates a small piece of Quarks' functionality. Quarks supports more complicated topologies, such as topologies that require merging and splitting data streams, or perform operations which aggregate the last <em>N</em> seconds of data (for example, calculating a moving average).</p>
-
-<p>For more complex examples, see:</p>
-
-<ul>
-<li><a href="samples">Quarks sample programs</a></li>
-<li><a href="common-quarks-operations">Common Quarks operations</a></li>
-</ul>
-
-
-<div class="tags">
-
-</div>
-
-<!--
-
- <div id="disqus_thread"></div>
- <script type="text/javascript">
- /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
- var disqus_shortname = 'idrbwjekyll'; // required: replace example with your forum shortname
-
- /* * * DON'T EDIT BELOW THIS LINE * * */
- (function() {
- var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
- dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
- (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
- })();
- </script>
- <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
- -->
-
-</div>
-
-
-
-<footer>
- <div class="row">
- <div class="col-lg-12 footer">
-
- Site last
- generated: Jul 21, 2016 <br/>
-
- </div>
- </div>
- <br/>
- <div class="row">
- <div class="col-md-12">
- <p class="small">Apache Quarks is an effort undergoing Incubation at The Apache Software
- Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects
- until a further review indicates that the infrastructure, communications, and decision making process
- have stabilized in a manner consistent with other successful ASF projects. While incubation status is
- not necessarily a reflection of the completeness or stability of the code, it does indicate that the
- project has yet to be fully endorsed by the ASF.</p>
- </div>
- </div>
- <div class="row">
- <div class="col-md-12">
- <p class="small">Copyright � 2016 The Apache Software Foundation. Licensed under the Apache
- License, Version 2.0.
- Apache, the Apache Feather logo, and the Apache Incubator project logo are trademarks of The Apache
- Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
- respective owners.</p>
- </div>
- </div>
-</footer>
-
- </div><!-- /.row -->
-
- </div> <!-- /.container -->
-
-</body>
-
-
-</html>
-