http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6b90be61/_site/docs/distill/index.html ---------------------------------------------------------------------- diff --git a/_site/docs/distill/index.html b/_site/docs/distill/index.html new file mode 100644 index 0000000..97b9c5e --- /dev/null +++ b/_site/docs/distill/index.html @@ -0,0 +1,479 @@ +<!DOCTYPE html> +<html lang="en"> + + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <title>Installation</title> + <meta name="description" content="Installing Apache Distill"> + + <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> + <script src="/semantic/dist/semantic.min.js"></script> + <script src="https://d3js.org/d3.v4.min.js";></script> + <script src="/js/main.js"></script> + + <link rel="stylesheet" href="/assets/main.css"> + <link rel="canonical" href="http://localhost:4000/docs/distill/";> + <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> + + +</head> + + + <body> + + <div class="site-header"> + <div id="main-menu" class="ui inverted padded fixed top borderless menu"> + <a class="site-title" href="/"> + <h3 class="ui inverted header item">Apache SensSoft</h3> + </a> + + <div class="right menu"> + <div class="ui dropdown item"> + Components + <div class="menu"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="ui dropdown item"> + <a href="/docs">Docs</a> + <div class="menu"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserALE.js</a> + <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <a class="item" href="/releases">Releases</a> + <a class="item" href="/community">Community</a> + </div> + </div> +</div> + + + <div class="main-wrapper"> + <div class="docs-wrapper"> + <div class="docs-sidebar"> + + + + + + + + + +<!-- <div class="ui inverted list"> + <a class="item" href="/docs">About the Docs</a> +</div> --> +<div id="docs-nav" class="ui inverted accordion"> + + <div class="title"> + + <i class="dropdown icon"></i> + Apache SensSoft + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/">About the Docs</a> + + <a class="item" href="/docs/contributing.html">Contributing</a> + + </div> + </div> + + + + <div class="title"> + + <i class="dropdown icon"></i> + System + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/system/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/userale/">About UserALE</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.js + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralejs/">Getting Started</a> + + <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> + + <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.pyqt + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralepyqt/">Installation</a> + + <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> + + <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> + + <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="active title"> + + <i class="dropdown icon"></i> + Distill + </div> + + <div class="active content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/distill/">Installation</a> + + <a class="item" href="/docs/distill/start.html">Getting Started</a> + + <a class="item" href="/docs/distill/api.html">API Documentation</a> + + <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> + + <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> + + <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> + + <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> + + <a class="item" href="/docs/distill/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Tap + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/tap/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Stout + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/stout/">About Stout</a> + + <a class="item" href="/docs/stout/start.html">Getting Started</a> + + </div> + </div> +</div> + + </div> + <div class="docs-content"> + <h2 class="ui header">Installation</h2> + <h3 id="installing-apache-distill">Installing Apache Distill</h3> + +<p>The first step is to install Apache Distill. First, checkout the latest version of Apache Distill.</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill.git +</code></pre> +</div> + +<p>Apache Distill is a python project, so it can be installed like any other python library. Several operating systems (Mac OS X, Major Versions of Linux/BSD) have Python pre-installed, so you should just have to run</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>easy_install distill +</code></pre> +</div> + +<div class="highlighter-rouge"><pre class="highlight"><code> or +</code></pre> +</div> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>pip install distill +</code></pre> +</div> + +<p>Users are strongly recommended to install Apache Distill in a virtualenv. Instructions to setup an virtual environment will be explained below.</p> + +<blockquote> + <p><strong>Note</strong>& +When the package is installed via easy_install or pip this function will be bound to the distill executable in the Python installationâs bin directory (on Windows - the Scripts directory).</p> +</blockquote> + +<h3 id="installing-apache-distill-in-an-virtual-environment">Installing Apache Distill in an Virtual Environment</h3> + +<p>virtualenv is a tool to create isolated Python environments. virtualenv creates a folder which contains all the necessary executables to use the packages that the Apache Distill project would need.</p> + +<p>Install virtualenv via pip:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>sudo env/bin/pip install virtualenv +</code></pre> +</div> + +<p>Start by changing directory into the root of Apache Distillâs project directory, and then use the virtualenv command-line tool to create a new environment:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>mkdir env + <span class="nv">$ </span>virtualenv env +</code></pre> +</div> + +<p>Activate environment:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span><span class="nb">source </span>env/bin/activate +</code></pre> +</div> + +<p>Install Apache Distill requirements:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip -r requirements.txt +</code></pre> +</div> + +<p>To build the source code and run all unit tests.</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/python setup.py develop <span class="nb">test</span> +</code></pre> +</div> + +<p>Launch local Apache Distill server, running on localhost:8090:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/dev +</code></pre> +</div> + +<p>Deactivate environment</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>deactivate +</code></pre> +</div> + +<h3 id="running-apache-distill-on-docker-compose">Running Apache Distill on Docker Compose</h3> +<p>From the project directory, start up Apache Distill in the background.</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>docker-compose up -d + <span class="nv">$ </span>docker-compose ps +</code></pre> +</div> + +<p>To stop services once youâve finished with them:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>docker-compose stop +</code></pre> +</div> + +<h3 id="deployment-with-nginx-and-gunicorn">Deployment with Nginx and Gunicorn</h3> + +<p>I will describe a setup with nginx as a web server on Ubuntu. A web server cannot communicate directly with a Flask application such as Apache Distill. Thus gunicorn will be used to act as a medium between the web server and Apache Distill. Gunicorn is like an application web server that will be running behind nginx, and it is WSGI compatible. It can communicate with applications that support WSGI â Flask, Django, etc.</p> + +<p>Install requirements.</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>sudo apt-get update + <span class="nv">$ </span>sudo apt-get install -y python python-pip nginx gunicorn +</code></pre> +</div> + +<p>Create a directory to store the project.</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>sudo mkdir /home/pubic_html <span class="o">&&</span> <span class="nb">cd</span> /home/public_html +</code></pre> +</div> + +<p>Download the project from the GitHub repository and copy the application to the /home/public_html directory.</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://git-wip-us.apache.org/repos/asf + /incubator-senssoft-distill.git /home/public_html +</code></pre> +</div> + +<p>Install Apache Distillâs requirements either globally or in a virutal environment:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip install -r requirements.txt +</code></pre> +</div> + +<p>Apache Distill has provided an nginx configuration file located in distill/deploy/nginx.conf.</p> + +<p>Gunicorn will use port 8000 and handle the incoming HTTP requests.</p> + +<p>Restart nginx to load the configuration changes.</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>sudo /etc/init.d/nginx restart +</code></pre> +</div> + +<p>Run gunicorn on port 8000.</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>gunicorn --workers 4 --bind unix:distill.sock -m 007 deploy/run_server:app +</code></pre> +</div> + +<p>Start a new browser instance and navigate to http://localhost.</p> + +<h3 id="installing-documentation">Installing Documentation</h3> + +<p>To save yourself the trouble, all up to date documentation is available at https://draperlaboratory.github.io/distill/.</p> + +<p>However, if you want to manully build the documentation, the instructions are below.</p> + +<p>First, install the documentation dependencies:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip install -r doc_requirements.txt +</code></pre> +</div> + +<p>To build Apache Distillâs documentation, create a directory at the root level of /distill called distill-docs.</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>mkdir distill-docs & <span class="nb">cd </span>distill-docs +</code></pre> +</div> + +<p>Execute build command:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="c"># Inside top-level docs/ directory.</span> + <span class="nv">$ </span>make html +</code></pre> +</div> + +<p>This should build the documentation in your shell, and output HTML. At then end, it should say something about documents being ready in distill-docs/html. You can now open them in your browser by typing</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>open distill-docs/html/index.html +</code></pre> +</div> + + </div> +</div> + + </div> + + <div class="footer ui inverted very padded vertical segment"> + <div class="ui vertical segment"> + <div class="ui four column grid"> + <div class="column"> + <h4 class="ui inverted header">About</h4> + <div class="ui inverted link list"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Docs</h4> + <div class="ui inverted link list"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserAle.js</a> + <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Community</h4> + <div class="ui inverted link list"> + <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> + <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> + <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> + <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> + <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Apache</h4> + <div class="ui inverted link list"> + <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> + <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> + <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> + <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> + <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> + </div> + </div> + </div> + </div> + <div class="ui inverted vertical segment"> + <div class="ui two column middle aligned grid"> + <div class="column"> + Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache 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. + </div> + <div class="center aligned column"> + <img class="component-image" src="/images/incubator-logo-white.png"> + <br> + Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. + </div> + </div> + </div> +</div> + + + </body> + +</html>
http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6b90be61/_site/docs/distill/models.html ---------------------------------------------------------------------- diff --git a/_site/docs/distill/models.html b/_site/docs/distill/models.html new file mode 100644 index 0000000..20b64ec --- /dev/null +++ b/_site/docs/distill/models.html @@ -0,0 +1,623 @@ +<!DOCTYPE html> +<html lang="en"> + + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <title>Apache Distill Models</title> + <meta name="description" content="Brew Interface class distill.models.brew.Brew"> + + <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> + <script src="/semantic/dist/semantic.min.js"></script> + <script src="https://d3js.org/d3.v4.min.js";></script> + <script src="/js/main.js"></script> + + <link rel="stylesheet" href="/assets/main.css"> + <link rel="canonical" href="http://localhost:4000/docs/distill/models.html";> + <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> + + +</head> + + + <body> + + <div class="site-header"> + <div id="main-menu" class="ui inverted padded fixed top borderless menu"> + <a class="site-title" href="/"> + <h3 class="ui inverted header item">Apache SensSoft</h3> + </a> + + <div class="right menu"> + <div class="ui dropdown item"> + Components + <div class="menu"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="ui dropdown item"> + <a href="/docs">Docs</a> + <div class="menu"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserALE.js</a> + <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <a class="item" href="/releases">Releases</a> + <a class="item" href="/community">Community</a> + </div> + </div> +</div> + + + <div class="main-wrapper"> + <div class="docs-wrapper"> + <div class="docs-sidebar"> + + + + + + + + + +<!-- <div class="ui inverted list"> + <a class="item" href="/docs">About the Docs</a> +</div> --> +<div id="docs-nav" class="ui inverted accordion"> + + <div class="title"> + + <i class="dropdown icon"></i> + Apache SensSoft + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/">About the Docs</a> + + <a class="item" href="/docs/contributing.html">Contributing</a> + + </div> + </div> + + + + <div class="title"> + + <i class="dropdown icon"></i> + System + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/system/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/userale/">About UserALE</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.js + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralejs/">Getting Started</a> + + <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> + + <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.pyqt + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralepyqt/">Installation</a> + + <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> + + <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> + + <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="active title"> + + <i class="dropdown icon"></i> + Distill + </div> + + <div class="active content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/distill/">Installation</a> + + <a class="item" href="/docs/distill/start.html">Getting Started</a> + + <a class="item" href="/docs/distill/api.html">API Documentation</a> + + <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> + + <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> + + <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> + + <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> + + <a class="item" href="/docs/distill/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Tap + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/tap/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Stout + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/stout/">About Stout</a> + + <a class="item" href="/docs/stout/start.html">Getting Started</a> + + </div> + </div> +</div> + + </div> + <div class="docs-content"> + <h2 class="ui header">Apache Distill Models</h2> + <h3 id="brew-interface">Brew Interface</h3> +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">brew</span><span class="o">.</span><span class="n">Brew</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Bases:</strong> object</p> +</blockquote> + +<blockquote> + <p>Distill supports basic CRUD operations and publishes the status of an persistenct database. Eventually it will support ingesting logs sent from an registered application.</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">create</span><span class="p">(</span><span class="n">app</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Register a new application in Distill</p> +</blockquote> + +<blockquote> + + <div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="p">{</span> + <span class="s2">"application"</span> <span class="err">:</span> <span class="s2">"xdata_v3"</span><span class="p">,</span> + <span class="s2">"health"</span> <span class="err">:</span> <span class="s2">"green"</span><span class="p">,</span> + <span class="s2">"num_docs"</span> <span class="err">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"status"</span> <span class="err">:</span> <span class="s2">"open"</span> +<span class="p">}</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Parameters:</strong></p> + <ul> + <li>app â [string] application name (e.g. xdata_v3)</li> + </ul> +</blockquote> + +<blockquote> + <p><strong>Returns:</strong></p> + <ul> + <li>[dict] dictionary of application and its meta information</li> + </ul> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">delete</span><span class="p">(</span><span class="n">app</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Technically closes the index so its content is not searchable.</p> +</blockquote> + +<blockquote> + <p><strong>Parameters:</strong></p> + <ul> + <li>app â [string] application name (e.g. xdata_v3)</li> + </ul> +</blockquote> + +<blockquote> + <p><strong>Returns:</strong></p> + <ul> + <li>[dict] status message of the event</li> + </ul> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">get_applications</span><span class="p">()</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Fetch all the registered applications in Distill.</p> +</blockquote> + +<blockquote> + <p><em>Note:</em> Private indexes starting with a period are not included in the result set</p> +</blockquote> + +<blockquote> + <p><strong>Returns:</strong></p> + <ul> + <li>[dict] dictionary of all registered applications and meta information</li> + </ul> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">get_status</span><span class="p">()</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Fetch the status of the underlying database instance.</p> +</blockquote> + +<blockquote> + <p><strong>Returns:</strong></p> + <ul> + <li>[bool] if connection to database instance has been established</li> + </ul> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">read</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Fetch meta data associated with an application</p> +</blockquote> + +<blockquote> + <p>Example:</p> + <div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="p">{</span> + <span class="s2">"application"</span> <span class="err">:</span> <span class="s2">"xdata_v3"</span><span class="p">,</span> + <span class="s2">"health"</span> <span class="err">:</span> <span class="s2">"green"</span><span class="p">,</span> + <span class="s2">"num_docs"</span> <span class="err">:</span> <span class="s2">"100"</span><span class="p">,</span> + <span class="s2">"status"</span> <span class="err">:</span> <span class="s2">"open"</span> + <span class="s2">"types"</span> <span class="err">:</span> <span class="p">{</span> + <span class="s2">"raw_logs"</span> <span class="err">:</span> <span class="p">{</span> + <span class="s2">"@timestamp"</span> <span class="err">:</span> <span class="s2">"date"</span><span class="p">,</span> + <span class="s2">"action"</span> <span class="err">:</span> <span class="s2">"string"</span><span class="p">,</span> + <span class="s2">"elementId"</span> <span class="err">:</span> <span class="s2">"string"</span> + <span class="p">},</span> + <span class="s2">"parsed"</span> <span class="err">:</span> <span class="p">{</span> + <span class="s2">"@timestamp"</span> <span class="err">:</span> <span class="s2">"date"</span><span class="p">,</span> + <span class="s2">"elementId_interval"</span> <span class="err">:</span> <span class="s2">"string"</span> + <span class="p">},</span> + <span class="s2">"graph"</span> <span class="err">:</span> <span class="p">{</span> + <span class="s2">"uniqueID"</span> <span class="err">:</span> <span class="s2">"string"</span><span class="p">,</span> + <span class="s2">"transition_count"</span> <span class="err">:</span> <span class="s2">"long"</span><span class="p">,</span> + <span class="s2">"p_value"</span> <span class="err">:</span> <span class="s2">"float"</span> + <span class="p">}</span> + <span class="p">}</span> +<span class="p">}</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Parameters:</strong></p> + <ul> + <li>app â [string] application name (e.g. xdata_v3)</li> + </ul> +</blockquote> + +<blockquote> + <p><strong>Returns:</strong></p> + <ul> + <li>[dict] dictionary of application and its meta information</li> + </ul> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">update</span><span class="p">(</span><span class="n">app</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Todo:</strong> Currently not implemented</p> +</blockquote> + +<h3 id="stout-interface">Stout Interface</h3> +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">stout</span><span class="o">.</span><span class="n">Stout</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Bases:</strong> object</p> +</blockquote> + +<blockquote> + <p>Main Stout class to support ingest and search operations.</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">ingest</span><span class="p">()</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Ingest data coming from Stout to Distill</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">stout</span><span class="o">.</span><span class="n">StoutDoc</span><span class="p">(</span><span class="n">meta</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Bases:</strong> elasticsearch_dsl.document.DocType</p> +</blockquote> + +<blockquote> + <p>Representation of a Stout document.</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">save</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Save data from parsing as a Stout document in Distill</p> +</blockquote> + +<h3 id="userale-interface">UserAle Interface</h3> +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">userale</span><span class="o">.</span><span class="n">UserAle</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Bases:</strong> object</p> +</blockquote> + +<blockquote> + <p>Main method of entry to perform segmentation and integration of STOUTâs master answer table (if STOUT is enabled). Advanced and basic analytics is performed in the distill.algorithms.stats and distill.algorithms.graphs module.</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">denoise</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="s">'parsed'</span><span class="p">,</span> <span class="n">save</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">search</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="p">[],</span> +<span class="n">size</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">include</span><span class="o">=</span><span class="s">'*'</span><span class="p">,</span> <span class="n">scroll</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">sort_field</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Perform a search query.</p> +</blockquote> + +<blockquote> + <p><strong>Parameters:</strong></p> + <ul> + <li>app â [string] application id (e.g. âxdata_v3â)</li> + <li>app_type â [string] name of the application type. If None all application types are searched.</li> + <li>filters â [list of strings] list of filters for a query.</li> + <li>size â [int] maximum number of hits that should be returned</li> + <li>sort_field â [string] sorting field. Currently supported fields: âtimestampâ, âdateâ</li> + </ul> +</blockquote> + +<blockquote> + <p><strong>Returns</strong></p> + <ul> + <li>[dict] dictionary with processed results. If STOUT is enabled, STOUT data will be merged with final result.</li> + </ul> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">segment</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="s">''</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Just support match all for now.</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">userale</span><span class="o">.</span><span class="n">merge_dicts</span><span class="p">(</span><span class="n">lst</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">userale</span><span class="o">.</span><span class="n">parse_query_parameters</span><span class="p">(</span><span class="n">indx</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">request_args</span><span class="o">=</span><span class="p">{})</span> +</code></pre> + </div> +</blockquote> + + </div> +</div> + + </div> + + <div class="footer ui inverted very padded vertical segment"> + <div class="ui vertical segment"> + <div class="ui four column grid"> + <div class="column"> + <h4 class="ui inverted header">About</h4> + <div class="ui inverted link list"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Docs</h4> + <div class="ui inverted link list"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserAle.js</a> + <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Community</h4> + <div class="ui inverted link list"> + <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> + <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> + <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> + <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> + <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Apache</h4> + <div class="ui inverted link list"> + <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> + <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> + <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> + <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> + <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> + </div> + </div> + </div> + </div> + <div class="ui inverted vertical segment"> + <div class="ui two column middle aligned grid"> + <div class="column"> + Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache 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. + </div> + <div class="center aligned column"> + <img class="component-image" src="/images/incubator-logo-white.png"> + <br> + Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. + </div> + </div> + </div> +</div> + + + </body> + +</html> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6b90be61/_site/docs/distill/start.html ---------------------------------------------------------------------- diff --git a/_site/docs/distill/start.html b/_site/docs/distill/start.html new file mode 100644 index 0000000..1b1108c --- /dev/null +++ b/_site/docs/distill/start.html @@ -0,0 +1,322 @@ +<!DOCTYPE html> +<html lang="en"> + + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <title>Getting Started</title> + <meta name="description" content="Usage"> + + <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> + <script src="/semantic/dist/semantic.min.js"></script> + <script src="https://d3js.org/d3.v4.min.js";></script> + <script src="/js/main.js"></script> + + <link rel="stylesheet" href="/assets/main.css"> + <link rel="canonical" href="http://localhost:4000/docs/distill/start.html";> + <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> + + +</head> + + + <body> + + <div class="site-header"> + <div id="main-menu" class="ui inverted padded fixed top borderless menu"> + <a class="site-title" href="/"> + <h3 class="ui inverted header item">Apache SensSoft</h3> + </a> + + <div class="right menu"> + <div class="ui dropdown item"> + Components + <div class="menu"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="ui dropdown item"> + <a href="/docs">Docs</a> + <div class="menu"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserALE.js</a> + <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <a class="item" href="/releases">Releases</a> + <a class="item" href="/community">Community</a> + </div> + </div> +</div> + + + <div class="main-wrapper"> + <div class="docs-wrapper"> + <div class="docs-sidebar"> + + + + + + + + + +<!-- <div class="ui inverted list"> + <a class="item" href="/docs">About the Docs</a> +</div> --> +<div id="docs-nav" class="ui inverted accordion"> + + <div class="title"> + + <i class="dropdown icon"></i> + Apache SensSoft + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/">About the Docs</a> + + <a class="item" href="/docs/contributing.html">Contributing</a> + + </div> + </div> + + + + <div class="title"> + + <i class="dropdown icon"></i> + System + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/system/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/userale/">About UserALE</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.js + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralejs/">Getting Started</a> + + <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> + + <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.pyqt + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralepyqt/">Installation</a> + + <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> + + <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> + + <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="active title"> + + <i class="dropdown icon"></i> + Distill + </div> + + <div class="active content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/distill/">Installation</a> + + <a class="item" href="/docs/distill/start.html">Getting Started</a> + + <a class="item" href="/docs/distill/api.html">API Documentation</a> + + <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> + + <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> + + <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> + + <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> + + <a class="item" href="/docs/distill/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Tap + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/tap/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Stout + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/stout/">About Stout</a> + + <a class="item" href="/docs/stout/start.html">Getting Started</a> + + </div> + </div> +</div> + + </div> + <div class="docs-content"> + <h2 class="ui header">Getting Started</h2> + <h3 id="usage">Usage</h3> + +<p>Using curl:</p> + +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>curl -XGET <span class="s1">'http://localhost:8090/app/register'</span> -d <span class="s1">'{ + "application_name" : "my_app", + "version" : "0.1", + "application_description" : "my test app" + }'</span> +</code></pre> +</div> + + </div> +</div> + + </div> + + <div class="footer ui inverted very padded vertical segment"> + <div class="ui vertical segment"> + <div class="ui four column grid"> + <div class="column"> + <h4 class="ui inverted header">About</h4> + <div class="ui inverted link list"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Docs</h4> + <div class="ui inverted link list"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserAle.js</a> + <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Community</h4> + <div class="ui inverted link list"> + <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> + <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> + <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> + <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> + <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Apache</h4> + <div class="ui inverted link list"> + <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> + <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> + <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> + <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> + <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> + </div> + </div> + </div> + </div> + <div class="ui inverted vertical segment"> + <div class="ui two column middle aligned grid"> + <div class="column"> + Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache 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. + </div> + <div class="center aligned column"> + <img class="component-image" src="/images/incubator-logo-white.png"> + <br> + Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. + </div> + </div> + </div> +</div> + + + </body> + +</html> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6b90be61/_site/docs/distill/utilities.html ---------------------------------------------------------------------- diff --git a/_site/docs/distill/utilities.html b/_site/docs/distill/utilities.html new file mode 100644 index 0000000..c3ccdd7 --- /dev/null +++ b/_site/docs/distill/utilities.html @@ -0,0 +1,409 @@ +<!DOCTYPE html> +<html lang="en"> + + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <title>Apache Distill Utilities</title> + <meta name="description" content="Query Builder class distill.utils.query_builder.QueryBuilder(query=None)"> + + <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> + <script src="/semantic/dist/semantic.min.js"></script> + <script src="https://d3js.org/d3.v4.min.js";></script> + <script src="/js/main.js"></script> + + <link rel="stylesheet" href="/assets/main.css"> + <link rel="canonical" href="http://localhost:4000/docs/distill/utilities.html";> + <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> + + +</head> + + + <body> + + <div class="site-header"> + <div id="main-menu" class="ui inverted padded fixed top borderless menu"> + <a class="site-title" href="/"> + <h3 class="ui inverted header item">Apache SensSoft</h3> + </a> + + <div class="right menu"> + <div class="ui dropdown item"> + Components + <div class="menu"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="ui dropdown item"> + <a href="/docs">Docs</a> + <div class="menu"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserALE.js</a> + <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <a class="item" href="/releases">Releases</a> + <a class="item" href="/community">Community</a> + </div> + </div> +</div> + + + <div class="main-wrapper"> + <div class="docs-wrapper"> + <div class="docs-sidebar"> + + + + + + + + + +<!-- <div class="ui inverted list"> + <a class="item" href="/docs">About the Docs</a> +</div> --> +<div id="docs-nav" class="ui inverted accordion"> + + <div class="title"> + + <i class="dropdown icon"></i> + Apache SensSoft + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/">About the Docs</a> + + <a class="item" href="/docs/contributing.html">Contributing</a> + + </div> + </div> + + + + <div class="title"> + + <i class="dropdown icon"></i> + System + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/system/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/userale/">About UserALE</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.js + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralejs/">Getting Started</a> + + <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> + + <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.pyqt + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralepyqt/">Installation</a> + + <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> + + <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> + + <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="active title"> + + <i class="dropdown icon"></i> + Distill + </div> + + <div class="active content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/distill/">Installation</a> + + <a class="item" href="/docs/distill/start.html">Getting Started</a> + + <a class="item" href="/docs/distill/api.html">API Documentation</a> + + <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> + + <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> + + <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> + + <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> + + <a class="item" href="/docs/distill/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Tap + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/tap/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Stout + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/stout/">About Stout</a> + + <a class="item" href="/docs/stout/start.html">Getting Started</a> + + </div> + </div> +</div> + + </div> + <div class="docs-content"> + <h2 class="ui header">Apache Distill Utilities</h2> + <h3 id="query-builder">Query Builder</h3> +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">query_builder</span><span class="o">.</span><span class="n">QueryBuilder</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Bases:</strong> object</p> +</blockquote> + +<h4 id="add_filtersfilters">add_filters(filters)</h4> + +<h4 id="add_sortingsort_field-sort_order">add_sorting(sort_field=ââ, sort_order=ââ)</h4> + +<h3 id="exception-handling">Exception Handling</h3> +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">exception</span> <span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">Error</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Bases:</strong> exceptions.Exception</p> +</blockquote> + +<blockquote> + <p>Base class for exceptions.</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">exception</span> <span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ValidationError</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Bases:</strong> distill.utils.exceptions.Error</p> +</blockquote> + +<blockquote> + <p>Exceptions raised for errors in validated a url.</p> +</blockquote> + +<h3 id="validation-library">Validation Library</h3> +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">validation</span><span class="o">.</span><span class="n">str2bool</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Convert string expression to boolean</p> +</blockquote> + +<blockquote> + <p><strong>Parameters:</strong></p> + <ul> + <li>v â Input value</li> + </ul> +</blockquote> + +<blockquote> + <p><strong>Returns:</strong></p> + <ul> + <li>Converted message as boolean type</li> + <li>Return type: bool</li> + </ul> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">validation</span><span class="o">.</span><span class="n">validate_request</span><span class="p">(</span><span class="n">q</span><span class="p">)</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p>Parse out request message and validate inputs</p> +</blockquote> + +<blockquote> + <p><strong>Parameters:</strong></p> + <ul> + <li>q â Url query string</li> + </ul> +</blockquote> + +<blockquote> + <p><strong>Raises:</strong></p> + <ul> + <li>ValidationError â if the query is missing required parameters</li> + </ul> +</blockquote> + + </div> +</div> + + </div> + + <div class="footer ui inverted very padded vertical segment"> + <div class="ui vertical segment"> + <div class="ui four column grid"> + <div class="column"> + <h4 class="ui inverted header">About</h4> + <div class="ui inverted link list"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Docs</h4> + <div class="ui inverted link list"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserAle.js</a> + <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Community</h4> + <div class="ui inverted link list"> + <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> + <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> + <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> + <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> + <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Apache</h4> + <div class="ui inverted link list"> + <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> + <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> + <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> + <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> + <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> + </div> + </div> + </div> + </div> + <div class="ui inverted vertical segment"> + <div class="ui two column middle aligned grid"> + <div class="column"> + Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache 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. + </div> + <div class="center aligned column"> + <img class="component-image" src="/images/incubator-logo-white.png"> + <br> + Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. + </div> + </div> + </div> +</div> + + + </body> + +</html> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6b90be61/_site/docs/index.html ---------------------------------------------------------------------- diff --git a/_site/docs/index.html b/_site/docs/index.html new file mode 100644 index 0000000..36f35c0 --- /dev/null +++ b/_site/docs/index.html @@ -0,0 +1,312 @@ +<!DOCTYPE html> +<html lang="en"> + + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <title>About the Docs</title> + <meta name="description" content="The Apache SensSoft docs are organized by product. Each productâs documentation includes information like quick start guides, tutorials, full API description..."> + + <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> + <script src="/semantic/dist/semantic.min.js"></script> + <script src="https://d3js.org/d3.v4.min.js";></script> + <script src="/js/main.js"></script> + + <link rel="stylesheet" href="/assets/main.css"> + <link rel="canonical" href="http://localhost:4000/docs/";> + <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> + + +</head> + + + <body> + + <div class="site-header"> + <div id="main-menu" class="ui inverted padded fixed top borderless menu"> + <a class="site-title" href="/"> + <h3 class="ui inverted header item">Apache SensSoft</h3> + </a> + + <div class="right menu"> + <div class="ui dropdown item"> + Components + <div class="menu"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="ui dropdown item"> + <a href="/docs">Docs</a> + <div class="menu"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserALE.js</a> + <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <a class="item" href="/releases">Releases</a> + <a class="item" href="/community">Community</a> + </div> + </div> +</div> + + + <div class="main-wrapper"> + <div class="docs-wrapper"> + <div class="docs-sidebar"> + + + + + + + + + +<!-- <div class="ui inverted list"> + <a class="item" href="/docs">About the Docs</a> +</div> --> +<div id="docs-nav" class="ui inverted accordion"> + + <div class="active title"> + + <i class="dropdown icon"></i> + Apache SensSoft + </div> + + <div class="active content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/">About the Docs</a> + + <a class="item" href="/docs/contributing.html">Contributing</a> + + </div> + </div> + + + + <div class="title"> + + <i class="dropdown icon"></i> + System + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/system/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/userale/">About UserALE</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.js + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralejs/">Getting Started</a> + + <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> + + <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.pyqt + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralepyqt/">Installation</a> + + <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> + + <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> + + <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Distill + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/distill/">Installation</a> + + <a class="item" href="/docs/distill/start.html">Getting Started</a> + + <a class="item" href="/docs/distill/api.html">API Documentation</a> + + <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> + + <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> + + <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> + + <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> + + <a class="item" href="/docs/distill/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Tap + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/tap/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Stout + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/stout/">About Stout</a> + + <a class="item" href="/docs/stout/start.html">Getting Started</a> + + </div> + </div> +</div> + + </div> + <div class="docs-content"> + <h2 class="ui header">About the Docs</h2> + <p>The Apache SensSoft docs are organized by product. Each productâs documentation includes information like quick start guides, tutorials, full API descriptions, and contributing guides.</p> + + </div> +</div> + + </div> + + <div class="footer ui inverted very padded vertical segment"> + <div class="ui vertical segment"> + <div class="ui four column grid"> + <div class="column"> + <h4 class="ui inverted header">About</h4> + <div class="ui inverted link list"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Docs</h4> + <div class="ui inverted link list"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserAle.js</a> + <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Community</h4> + <div class="ui inverted link list"> + <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> + <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> + <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> + <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> + <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Apache</h4> + <div class="ui inverted link list"> + <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> + <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> + <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> + <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> + <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> + </div> + </div> + </div> + </div> + <div class="ui inverted vertical segment"> + <div class="ui two column middle aligned grid"> + <div class="column"> + Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache 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. + </div> + <div class="center aligned column"> + <img class="component-image" src="/images/incubator-logo-white.png"> + <br> + Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. + </div> + </div> + </div> +</div> + + + </body> + +</html> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6b90be61/_site/docs/stout/index.html ---------------------------------------------------------------------- diff --git a/_site/docs/stout/index.html b/_site/docs/stout/index.html new file mode 100644 index 0000000..7072073 --- /dev/null +++ b/_site/docs/stout/index.html @@ -0,0 +1,332 @@ +<!DOCTYPE html> +<html lang="en"> + + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <title>About Stout</title> + <meta name="description" content="The Subject Tracker for Online User Testing (STOUT) is a content management system for formal human performance experimentation. STOUT presents tools and ope..."> + + <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> + <script src="/semantic/dist/semantic.min.js"></script> + <script src="https://d3js.org/d3.v4.min.js";></script> + <script src="/js/main.js"></script> + + <link rel="stylesheet" href="/assets/main.css"> + <link rel="canonical" href="http://localhost:4000/docs/stout/";> + <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> + + +</head> + + + <body> + + <div class="site-header"> + <div id="main-menu" class="ui inverted padded fixed top borderless menu"> + <a class="site-title" href="/"> + <h3 class="ui inverted header item">Apache SensSoft</h3> + </a> + + <div class="right menu"> + <div class="ui dropdown item"> + Components + <div class="menu"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="ui dropdown item"> + <a href="/docs">Docs</a> + <div class="menu"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserALE.js</a> + <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <a class="item" href="/releases">Releases</a> + <a class="item" href="/community">Community</a> + </div> + </div> +</div> + + + <div class="main-wrapper"> + <div class="docs-wrapper"> + <div class="docs-sidebar"> + + + + + + + + + +<!-- <div class="ui inverted list"> + <a class="item" href="/docs">About the Docs</a> +</div> --> +<div id="docs-nav" class="ui inverted accordion"> + + <div class="title"> + + <i class="dropdown icon"></i> + Apache SensSoft + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/">About the Docs</a> + + <a class="item" href="/docs/contributing.html">Contributing</a> + + </div> + </div> + + + + <div class="title"> + + <i class="dropdown icon"></i> + System + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/system/">Getting Started</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/userale/">About UserALE</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.js + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralejs/">Getting Started</a> + + <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> + + <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + UserALE.pyqt + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/useralepyqt/">Installation</a> + + <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> + + <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> + + <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Distill + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/distill/">Installation</a> + + <a class="item" href="/docs/distill/start.html">Getting Started</a> + + <a class="item" href="/docs/distill/api.html">API Documentation</a> + + <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> + + <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> + + <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> + + <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> + + <a class="item" href="/docs/distill/changelog.html">Changelog</a> + + </div> + </div> + + + <div class="title"> + + <i class="dropdown icon"></i> + Tap + </div> + + <div class="content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/tap/">Getting Started</a> + + </div> + </div> + + + <div class="active title"> + + <i class="dropdown icon"></i> + Stout + </div> + + <div class="active content"> + + <div class="ui inverted bulleted list docs-list"> + + <a class="item" href="/docs/stout/">About Stout</a> + + <a class="item" href="/docs/stout/start.html">Getting Started</a> + + </div> + </div> +</div> + + </div> + <div class="docs-content"> + <h2 class="ui header">About Stout</h2> + <p>The Subject Tracker for Online User Testing (STOUT) is a content management system for formal human performance experimentation. STOUT presents tools and operational tasks to each participant. In doing so, it collects:</p> + +<ul> + <li>an intake questionnaire to assess the userâs background and experience as an analyst</li> + <li>operational task performance and confidence in responses i.e. did they get the right answer? How sure are they?</li> + <li>subjective feedback (did they like how the tool worked?)</li> + <li>screen captures</li> + <li>physiological response, which help infer operator workload (how hard did they work?).</li> +</ul> + +<p>The STOUT system provides human-subjects testing experiment administrators with a flexible tool for managing and tracking user progress through a series of online tasks. The STOUT system was designed to help collect information about the utility of online applications.</p> + +<h3 id="who-is-stout-for">Who is STOUT for?</h3> + +<p>This package is for developers. A framework has been built but many features and additions can still be added.</p> + +<p>This package is also for experiment administrators. This system can be used immediately to conduct new evaluations of online applications.</p> + +<h3 id="for-more-information">For more information</h3> + +<p>STOUT was built using Django 1.6. For more advanced developer information or instructions on how to setup your own system, consult the documentation for Django <a href="https://www.djangoproject.com/";>here</a>.</p> + + </div> +</div> + + </div> + + <div class="footer ui inverted very padded vertical segment"> + <div class="ui vertical segment"> + <div class="ui four column grid"> + <div class="column"> + <h4 class="ui inverted header">About</h4> + <div class="ui inverted link list"> + <a class="item" href="/system">System</a> + <a class="item" href="/userale">UserALE</a> + <a class="item" href="/distill">Distill</a> + <a class="item" href="/tap">Tap</a> + <a class="item" href="/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Docs</h4> + <div class="ui inverted link list"> + <a class="item" href="/docs/system">System</a> + <a class="item" href="/docs/userale">UserALE</a> + <a class="item" href="/docs/useralejs">UserAle.js</a> + <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> + <a class="item" href="/docs/distill">Distill</a> + <a class="item" href="/docs/tap">Tap</a> + <a class="item" href="/docs/stout">Stout</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Community</h4> + <div class="ui inverted link list"> + <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> + <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> + <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> + <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> + <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> + </div> + </div> + <div class="column"> + <h4 class="ui inverted header">Apache</h4> + <div class="ui inverted link list"> + <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> + <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> + <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> + <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> + <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> + </div> + </div> + </div> + </div> + <div class="ui inverted vertical segment"> + <div class="ui two column middle aligned grid"> + <div class="column"> + Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache 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. + </div> + <div class="center aligned column"> + <img class="component-image" src="/images/incubator-logo-white.png"> + <br> + Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. + </div> + </div> + </div> +</div> + + + </body> + +</html>
