http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_pages/releases.html ---------------------------------------------------------------------- diff --git a/_pages/releases.html b/_pages/releases.html new file mode 100644 index 0000000..be95ba4 --- /dev/null +++ b/_pages/releases.html @@ -0,0 +1,16 @@ +--- +layout: basic +permalink: /releases/ +title: Releases +--- + +<p> + Apache SensSoft is currently preparing for its first full release. Stay tuned and sign up for our mailing lists to keep up to date! +</p> + +<a class="ui blue button" href="mailto:dev-subscr...@senssoft.incubator.apache.org";> + Dev List +</a> +<a class="ui yellow button" href="mailto:users-subscr...@senssoft.incubator.apache.org";> + User List +</a>
http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_pages/stout.html ---------------------------------------------------------------------- diff --git a/_pages/stout.html b/_pages/stout.html new file mode 100644 index 0000000..3da7ea7 --- /dev/null +++ b/_pages/stout.html @@ -0,0 +1,38 @@ +--- +layout: component +permalink: /stout/ +title: Stout +image: /images/stout_inverted.png +component: Stout + +description: Apache STOUT (Subject Tracking and Online User Testing) is for UI/UX (and behavioral) researchers that want to perform formal user-testing studies and experiments with web applications. In STOUT, you'll be able to track participants through a series of URLs in a sequence that matches your experimental designâboth between and within-subject designs. STOUT makes sure that your participants are sent to the right URLs in the right sequence. You can also set timing parameters so that each task at different URLs are uniformly timed. Participants can also be given directed tasks paired with different URLs. Currently STOUT works well with SurveyMonkey, meaning you can design questionnaires for delivery before, during and after their experience at a given URL. STOUT tracks users with anonymous identifiers (hashes) that are passed to the URLs you send your participants to. These are generated during a registration step, which can also configured for human-subjects testing compl iant workflows. This hash is appended with a task ID and then passed to UserALE so that every log generated through web applications during your experiment is traceable to specific users and tasks. STOUT also has features for extracting data from SurveyMonkey and organizing all the data you collect through SurveyMonkey and STOUT throughout experiments, providing you with a simple and easy-to-use .csv file for analysis. Other scripts can be configured to run with STOUT and SurveyMongo for automated post-processing, scale-computation, and truthing. Additionally, STOUT will generate completion codes so that it is easy to use with Amazon Mechanical Turk, and features both an acheivement and email system so that you can communicate with and engage your participants. STOUT is built in Django so its easy to customize STOUT for your specific needs. + +features: + - + icon: lab + color: blue + title: Perform experiments + description: STOUT allows you to track users as they interact with different applications or different versions of the same applications in simple experimental designs. STOUT's Django back end allows you collect task sequence data and even randomize or counterbalance your experiments without losing track of what users are interacting with and when. + - + icon: database + color: yellow + title: Wrangle different data sources + description: STOUT allows you to track users between different sources of information using an anonymous user hash. Collect demographics and psychometrics from form data, present users with tasks and questions while they interact with applications, and collect user behavior through UserALE without losing track of who generated the data. + - + icon: cloud download + color: red + title: Fuse data for analysis + description: With the SurveyMongo extension to STOUT you can automate polling for survey data and integrate with STOUT metadata to provide tabular datasets that make statistical analysis easy. + - + icon: refresh + color: green + title: Automate data preprocessing + description: STOUT's architecture makes it easy to run batch processing scripts in R or python, server-side. Perform your truthing, aggregation, and data transformations automatically, triggered by flags in STOUT, so that you can get straight to analysis. + - + icon: bar chart + color: blue + title: Visualize experimental findings + description: STOUT features a dashboard so that you can effectively manage multiple experiments and visualize your results using D3 packages. + +contentCount: 0 +--- http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_pages/system.html ---------------------------------------------------------------------- diff --git a/_pages/system.html b/_pages/system.html new file mode 100644 index 0000000..cba0968 --- /dev/null +++ b/_pages/system.html @@ -0,0 +1,38 @@ +--- +layout: component +permalink: /system/ +title: The Apache SensSoft System +subtitle: Easy combined deployment with Docker +component: Apache SensSoft + +description: Apache SensSoft is a line of products that provides all the components needed for tracking, analyzing and visualizing user event data. Apache UserALE provides comprehensive user event tracking for web pages, but it is specially engineered for toolsâapplications users will use in their work. Apache Distill is an analytics framework for handling and analyzing UserALE data. Apache TAP provides you with a customizable array of interactive visual analytic libraries (D3) to extract insights from your usage data, and a single point of access for end users of the SensSoft system. Each component is available on their own through our Apache repositories. However, we have bundled these components into an easy-to-deploy, pre-configured Docker container so that you can begin to collect data as soon as possible. + +features: + - + icon: cloud + color: blue + title: Containerized + description: Deploy on your infrastructure or in the cloud quickly and easily with Docker. + - + icon: rocket + color: yellow + title: Ready to Go + description: No configuration or connections to make to get a basic setup up and running. + - + icon: settings + color: red + title: Customizable + description: Switch out or modify components for your use case. Integrate with your existing system. + +contentCount: 1 +--- + +<div class="ui very padded vertical segment"> + <div class="ui center aligned text container"> + <h2 class="ui header">What's Included?</h2> + <p> + The Apache SensSoft System includes a complete backend deployment of UserALE, Distill, and Tap. The different components are connected as seen below and ready to work together out of the box. UserALE clients will still need to be included in the target applications to push logs into the system. + </p> + <img class="segment-image" src="/images/system.png"> + </div> +</div> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_pages/tap.html ---------------------------------------------------------------------- diff --git a/_pages/tap.html b/_pages/tap.html new file mode 100644 index 0000000..fad7ab8 --- /dev/null +++ b/_pages/tap.html @@ -0,0 +1,30 @@ +--- +layout: component +permalink: /tap/ +title: Tap +image: /images/tap_inverted.png +component: Tap + +description: Apache TAP (Test Application Portal) is a single point of entry into your SensSoft system. TAP features registration features served through Djangoâregister your application, organization, and yourself to control access to your applications' usage data and manage custom configurations in TAP. TAP also provides you with a customizable array of interactive visual analytic libraries to extract insights from your usage data. You'll have many of the features you've come to rely on from other productsâthrough TAP you can explore how users interact with each element of your application, and how they interacted with each of them. With TAP you'll also be able to visually compare usage between different segments of your user base and perform A/B usability testing between different versions of your applicationâyou'll have access to any data you collect on your users and statistics, metrics or modeling output that is built into Distill. TAP also provides you with beautiful cu stom D3 visualizations of your users' workflows in your application. See how they do work with your application and learn how your application design augments their workflow or prevents them from discovering other features. TAP comes with many "out-of-the-box" features for extracting insight from usage data, but it is designed for customization. + +features: + - + icon: users + color: blue + title: Understand your users + description: TAP allows you to visualize how you application is used by different sets of users based on their characteristics (e.g., geography, demographics). + - + icon: ordered list + color: yellow + title: Understand how your application is used + description: TAP comes with custom visualization for how your users interact with elements of your application in sequence revealing insights about how application design affects usage and efficiency. + - + icon: lock + color: red + title: Control access to your data (coming soon) + description: Control permissions for how your organization can access user data by setting permissions at the instutitional level down to access to data collected from specific applications. + +contentCount: 1 +--- + +{% include tapDemo.html inverted=false %} http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_pages/userale.html ---------------------------------------------------------------------- diff --git a/_pages/userale.html b/_pages/userale.html new file mode 100644 index 0000000..6b4dd05 --- /dev/null +++ b/_pages/userale.html @@ -0,0 +1,45 @@ +--- +layout: component +permalink: /userale/ +title: UserAle +image: /images/userale_inverted.png +component: UserALE + +description: Apache UserALE (User Analytic Logging Engine) is the beating heart of Apache SensSoft technology. UserALE provides instrumentation for applications, turning them into human use sensors. UserALE provides comprehensive user event tracking for web pages, but it is specially engineered for toolsâapplications users will use in their work. UserALE will transmit specially structured messages from your application to an activity logging server whenever your users interact with it. Apply UserALE with a single line of code and capture every user interaction without having to separately manage tags on each feature of your application. UserALE works with Elastic and other open source databasesâyou own your data and you can access it for analysis and automation without restriction. UserALE.js serves Javascript applications. For desktop applications written in PyQt5 see UserALE.PyQt5. + +features: + - + icon: thumbs up + color: blue + title: Low-effort + description: Embed UserALE with a single script tag in source, or from your browser console for testing. + - + icon: settings + color: yellow + title: Customizable + description: UserALE provides options for custom, manual instrumentation. + - + icon: mouse pointer + color: red + title: Capture every event + description: And the document object model targets of those events, with resolution suitable for advanced behavioral analytics. + - + icon: database + color: green + title: Own your own data + description: UserALE utilizes Elastic as a scalable, searchable database for user event log storage. + - + icon: dashboard + color: blue + title: Low processing overhead + description: UserALE will not adversely affect your applications performance. + - + icon: protect + color: yellow + title: Never lose data + description: Temporary offline log storage safeguards from dropped signal due to connectivity issues. + +contentCount: 1 +--- + +{% include useralejsDemo.html inverted=false %} http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_sass/_bowie.scss ---------------------------------------------------------------------- diff --git a/_sass/_bowie.scss b/_sass/_bowie.scss new file mode 100644 index 0000000..f1ebb23 --- /dev/null +++ b/_sass/_bowie.scss @@ -0,0 +1,13 @@ +.tooltip { + position: absolute; + text-align: center; + font: 12px sans-serif; + min-width: 100px; + min-height: 24px; + padding: 4px; + pointer-events: none; + background-color: $white; + border-style: solid; + border-width: 1px; + border-color: $grey; +} http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_sass/_highlighting.scss ---------------------------------------------------------------------- diff --git a/_sass/_highlighting.scss b/_sass/_highlighting.scss new file mode 100644 index 0000000..23a512a --- /dev/null +++ b/_sass/_highlighting.scss @@ -0,0 +1,64 @@ +/** + * Syntax highlighting styles + */ +.highlight { + .c { color: $grey; font-style: italic } // Comment + .err { color: $red } // Error + .k { font-weight: bold } // Keyword + .o { font-weight: bold } // Operator + .cm { color: $grey; font-style: italic } // Comment.Multiline + .cp { color: $grey; font-weight: bold } // Comment.Preproc + .c1 { color: $grey; font-style: italic } // Comment.Single + .cs { color: $grey; font-weight: bold; font-style: italic } // Comment.Special + .gd { color: $black } // Generic.Deleted + .gd .x { color: $black } // Generic.Deleted.Specific + .ge { font-style: italic } // Generic.Emph + .gr { color: $red } // Generic.Error + .gh { color: $grey } // Generic.Heading + .gi { color: $black } // Generic.Inserted + .gi .x { color: $black} // Generic.Inserted.Specific + .go { color: $grey } // Generic.Output + .gp { color: $grey } // Generic.Prompt + .gs { font-weight: bold } // Generic.Strong + .gu { color: $grey } // Generic.Subheading + .gt { color: $red } // Generic.Traceback + .kc { font-weight: bold } // Keyword.Constant + .kd { font-weight: bold } // Keyword.Declaration + .kp { font-weight: bold } // Keyword.Pseudo + .kr { font-weight: bold } // Keyword.Reserved + .kt { color: $teal; font-weight: bold } // Keyword.Type + .m { color: $blue } // Literal.Number + .s { color: $red } // Literal.String + .na { color: $teal } // Name.Attribute + .nb { color: $blue } // Name.Builtin + .nc { color: $blue; font-weight: bold } // Name.Class + .no { color: $teal } // Name.Constant + .ni { color: $purple } // Name.Entity + .ne { color: $red; font-weight: bold } // Name.Exception + .nf { color: $red; font-weight: bold } // Name.Function + .nn { color: $grey } // Name.Namespace + .nt { color: $blue } // Name.Tag + .nv { color: $teal } // Name.Variable + .ow { font-weight: bold } // Operator.Word + .w { color: $grey } // Text.Whitespace + .mf { color: $green } // Literal.Number.Float + .mh { color: $green } // Literal.Number.Hex + .mi { color: $green } // Literal.Number.Integer + .mo { color: $green } // Literal.Number.Oct + .sb { color: $red } // Literal.String.Backtick + .sc { color: $red } // Literal.String.Char + .sd { color: $red } // Literal.String.Doc + .s2 { color: $red } // Literal.String.Double + .se { color: $red } // Literal.String.Escape + .sh { color: $red } // Literal.String.Heredoc + .si { color: $red } // Literal.String.Interpol + .sx { color: $red } // Literal.String.Other + .sr { color: $green } // Literal.String.Regex + .s1 { color: $red } // Literal.String.Single + .ss { color: $purple } // Literal.String.Symbol + .bp { color: $grey } // Name.Builtin.Pseudo + .vc { color: $teal } // Name.Variable.Class + .vg { color: $teal } // Name.Variable.Global + .vi { color: $teal } // Name.Variable.Instance + .il { color: $green } // Literal.Number.Integer.Long +} http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_sass/_senssoft.scss ---------------------------------------------------------------------- diff --git a/_sass/_senssoft.scss b/_sass/_senssoft.scss new file mode 100644 index 0000000..4b4dbc7 --- /dev/null +++ b/_sass/_senssoft.scss @@ -0,0 +1,88 @@ +body { + display: flex; + flex-direction: column; +} + +.site-header { + flex: 0 0; +} + +.main-wrapper { + flex: 1 0; + height: auto; + padding-top: 50px; +} + +.footer { + flex: 0 0; + width: 100%; + text-align: center; +} + +#main-menu { + height: 50px !important; +} + +.page-wrapper { + padding: 2em 0 2em 0; +} + +#main-masthead { + padding: 10em; + background-image: url("/images/header.svg"); + background-repeat: no-repeat; + background-position: center; +} + +.blank-masthead { + padding: 10em !important; +} + +.image-masthead { + padding: 6.8em !important; +} + +.docs-wrapper { + display: flex; +} + +.docs-sidebar { + flex: 1 0 180px; + padding: 2em; + background-color: $grey; + min-height: calc(100vh - 50px); +} + +.docs-content { + flex: 8; + padding: 2em; +} + +.docs-list { + margin-left: 3em !important; +} + +.docs-list > a.item:before { + color: $white !important; +} + +.component-image { + max-width: 100%; + max-height: 170px; +} + +.site-title { + white-space: nowrap; +} + +.segment-image { + max-width: 100%; +} + +.feature-description { + color: $white; +} + +.indented { + padding-left: 2em; +} http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_sass/_userale.scss ---------------------------------------------------------------------- diff --git a/_sass/_userale.scss b/_sass/_userale.scss new file mode 100644 index 0000000..7ce19f2 --- /dev/null +++ b/_sass/_userale.scss @@ -0,0 +1,14 @@ +#log-feed { + height: 720px; + overflow-y: hidden; +} + +#map-example { + min-height: 300px; + width: 100%; + z-index: 0; +} + +#demo-dropdown>.default.text { + color: $grey !important; +} http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_site/assets/main.css ---------------------------------------------------------------------- diff --git a/_site/assets/main.css b/_site/assets/main.css new file mode 100644 index 0000000..a6c448d --- /dev/null +++ b/_site/assets/main.css @@ -0,0 +1,226 @@ +body { + display: flex; + flex-direction: column; } + +.site-header { + flex: 0 0; } + +.main-wrapper { + flex: 1 0; + height: auto; + padding-top: 50px; } + +.footer { + flex: 0 0; + width: 100%; + text-align: center; } + +#main-menu { + height: 50px !important; } + +.page-wrapper { + padding: 2em 0 2em 0; } + +#main-masthead { + padding: 10em; + background-image: url("/images/header.svg"); + background-repeat: no-repeat; + background-position: center; } + +.blank-masthead { + padding: 10em !important; } + +.image-masthead { + padding: 6.8em !important; } + +.docs-wrapper { + display: flex; } + +.docs-sidebar { + flex: 1 0 180px; + padding: 2em; + background-color: #54595B; + min-height: calc(100vh - 50px); } + +.docs-content { + flex: 8; + padding: 2em; } + +.docs-list { + margin-left: 3em !important; } + +.docs-list > a.item:before { + color: #EBEBEB !important; } + +.component-image { + max-width: 100%; + max-height: 170px; } + +.site-title { + white-space: nowrap; } + +.segment-image { + max-width: 100%; } + +.feature-description { + color: #EBEBEB; } + +.indented { + padding-left: 2em; } + +/** + * Syntax highlighting styles + */ +.highlight .c { + color: #54595B; + font-style: italic; } +.highlight .err { + color: #E24614; } +.highlight .k { + font-weight: bold; } +.highlight .o { + font-weight: bold; } +.highlight .cm { + color: #54595B; + font-style: italic; } +.highlight .cp { + color: #54595B; + font-weight: bold; } +.highlight .c1 { + color: #54595B; + font-style: italic; } +.highlight .cs { + color: #54595B; + font-weight: bold; + font-style: italic; } +.highlight .gd { + color: #262626; } +.highlight .gd .x { + color: #262626; } +.highlight .ge { + font-style: italic; } +.highlight .gr { + color: #E24614; } +.highlight .gh { + color: #54595B; } +.highlight .gi { + color: #262626; } +.highlight .gi .x { + color: #262626; } +.highlight .go { + color: #54595B; } +.highlight .gp { + color: #54595B; } +.highlight .gs { + font-weight: bold; } +.highlight .gu { + color: #54595B; } +.highlight .gt { + color: #E24614; } +.highlight .kc { + font-weight: bold; } +.highlight .kd { + font-weight: bold; } +.highlight .kp { + font-weight: bold; } +.highlight .kr { + font-weight: bold; } +.highlight .kt { + color: #283F4E; + font-weight: bold; } +.highlight .m { + color: #38A6D8; } +.highlight .s { + color: #E24614; } +.highlight .na { + color: #283F4E; } +.highlight .nb { + color: #38A6D8; } +.highlight .nc { + color: #38A6D8; + font-weight: bold; } +.highlight .no { + color: #283F4E; } +.highlight .ni { + color: #852EB7; } +.highlight .ne { + color: #E24614; + font-weight: bold; } +.highlight .nf { + color: #E24614; + font-weight: bold; } +.highlight .nn { + color: #54595B; } +.highlight .nt { + color: #38A6D8; } +.highlight .nv { + color: #283F4E; } +.highlight .ow { + font-weight: bold; } +.highlight .w { + color: #54595B; } +.highlight .mf { + color: #BFD02C; } +.highlight .mh { + color: #BFD02C; } +.highlight .mi { + color: #BFD02C; } +.highlight .mo { + color: #BFD02C; } +.highlight .sb { + color: #E24614; } +.highlight .sc { + color: #E24614; } +.highlight .sd { + color: #E24614; } +.highlight .s2 { + color: #E24614; } +.highlight .se { + color: #E24614; } +.highlight .sh { + color: #E24614; } +.highlight .si { + color: #E24614; } +.highlight .sx { + color: #E24614; } +.highlight .sr { + color: #BFD02C; } +.highlight .s1 { + color: #E24614; } +.highlight .ss { + color: #852EB7; } +.highlight .bp { + color: #54595B; } +.highlight .vc { + color: #283F4E; } +.highlight .vg { + color: #283F4E; } +.highlight .vi { + color: #283F4E; } +.highlight .il { + color: #BFD02C; } + +.tooltip { + position: absolute; + text-align: center; + font: 12px sans-serif; + min-width: 100px; + min-height: 24px; + padding: 4px; + pointer-events: none; + background-color: #EBEBEB; + border-style: solid; + border-width: 1px; + border-color: #54595B; } + +#log-feed { + height: 720px; + overflow-y: hidden; } + +#map-example { + min-height: 300px; + width: 100%; + z-index: 0; } + +#demo-dropdown > .default.text { + color: #54595B !important; } http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/855d3ab1/_site/community/index.html ---------------------------------------------------------------------- diff --git a/_site/community/index.html b/_site/community/index.html new file mode 100644 index 0000000..1c1916a --- /dev/null +++ b/_site/community/index.html @@ -0,0 +1,232 @@ +<!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>Community</title> + <meta name="description" content="The homepage for Apache SensSoft"> + + <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/community/";> + <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="page-wrapper ui text container"> + <h1 class="ui header"> + Community + </h1> + <div class="page-content"> + <div class="ui vertical segment"> + <p> + The Apache SensSoft team happily welcomes contributors and supporters of our work. Contributions, bug reports, and suggestions are welcome for the core products, website, documentation, and everything else! See our <a href="/docs/system/contributing">docs</a> for more information on submitting effective contributions and bug reports. + </p> +</div> + +<div class="ui vertical segment"> + <h2 class="ui header">Mailing Lists</h2> + <h3 class="ui header"> + <i class="user icon"></i> + <div class="content">Users</div> + </h3> + <p> + For users of Apache SensSoft who want to keep up to date with new releases and community highlights. To subscribe, email <a href="mailto:user-subscr...@senssoft.incubator.apache.org";>user-subscr...@senssoft.incubator.apache.org</a>. + </p> + <h3 class="ui header"> + <i class="code icon"></i> + <div class="content">Dev</div> + </h3> + <p> + For contributors to Apache SensSoft or those interested in ongoing design and development efforts. To subscribe, email <a href="mailto:dev-subscr...@senssoft.incubator.apache.org";>dev-subscr...@senssoft.incubator.apache.org</a>. + </p> + <h3 class="ui header"> + <i class="upload icon"></i> + <div class="content">Commits</div> + </h3> + <p> + For emails-on-commit across all Apache SensSoft products. To subscribe, email <a href="mailto:commits-subscr...@senssoft.incubator.apache.org";>commits-subscr...@senssoft.incubator.apache.org</a>. + </p> +</div> + +<div class="ui vertical segment"> + <h2 class="ui header">Community Hubs</h2> + <h3 class="ui header"> + <i class="github icon"></i> + <div class="content">GitHub</div> + </h3> + <p> + <a href="https://github.com/apache?q=senssoft";>Find our code on Github</a> to browse and contribute. + </p> + <h3 class="ui header"> + <i class="twitter icon"></i> + <div class="content">Twitter</div> + </h3> + <p> + <a href="https://twitter.com/apachesenssoft";>Follow us on Twitter</a> to keep up to date on Apache SensSoft and related developments. + </p> + <h3 class="ui header"> + <i class="stack overflow icon"></i> + <div class="content">StackOverflow</div> + </h3> + <p> + Get your questions answered on <a href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a>. + </p> + <h3 class="ui header"> + <i class="bug icon"></i> + <div class="content">Issues and Bugs</div> + </h3> + <p> + Visit our <a href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> for full information on current developments, bugs, etc. + </p> + <h3 class="ui header"> + <i class="sticky note icon"></i> + <div class="content">Wiki</div> + </h3> + <p> + See our <a href="https://cwiki.apache.org/confluence/display/SENSSOFT";>wiki</a> for detailed information on project organization, roadmaps, etc. + </p> +</div> + +<div class="ui vertical segment"> + <h2 class="ui header">Contributors</h2> + <p> + Thank you to all our contributors! Want to be added? Contribute and <a href="mailto:d...@senssoft.incubator.apache.org";>contact us!</a> + </p> + <ul class="ui list"> + <li>Michelle Beard</li> + <li>Hugh Enxing</li> + <li>Kyle Finley</li> + <li>Robert Foley</li> + <li>Alex Ford</li> + <li>Clay Gimenez</li> + <li>Laura Mariano</li> + <li>Lewis John McGibbney</li> + <li>Joshua Poore</li> + <li>David Reed</li> + <li>Fei Sun</li> + <li>Dan Traviglia</li> + <li>Arthi Vezhavendan</li> + <li>Steve York</li> + </ul> +</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/855d3ab1/_site/distill/index.html ---------------------------------------------------------------------- diff --git a/_site/distill/index.html b/_site/distill/index.html new file mode 100644 index 0000000..784bf24 --- /dev/null +++ b/_site/distill/index.html @@ -0,0 +1,225 @@ +<!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>Distill</title> + <meta name="description" content="The homepage for Apache SensSoft"> + + <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/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="ui image-masthead masthead padded center aligned inverted vertical segment"> + <img class="component-image" src="/images/distill_inverted.png"> + </div> + + +<div class="ui very padded vertical segment"> + <div class="ui center aligned text container"> + <p> + Apache Distill is an analytics framework for handling and analyzing UserALE data. Distill allows you to focus on the data you want and model it. Distill empowers you to learn more from your data than any commercial service; use Distill's analytic libraries to generate statistics on how users interact with different elements of your application and also understand how users interact with your applications. Distill specializes in models of sequence and workflow so that you can understand how users experiment with your application and whether they interact with your application the way you expected. Distill is written in Python and built for scalable growth and customization. + </p> + </div> +</div> + +<div class="ui inverted grey very padded vertical segment"> + <div class="ui center aligned text container"> + <h2 class="ui inverted header">Features</h2> + + <div class="ui basic padded vertical segment"> + <div class="ui middle aligned two column grid"> + <div class="column"> + <i class="huge circular inverted blue search icon"></i> + </div> + <div class="column"> + <h3 class="ui inverted header">Easy, efficient queries</h3> + <div class="feature-description"> + Distill utilizes RESTful APIs to streamline making calls to your UserALE log database. + </div> + </div> + </div> + </div> + + <div class="ui basic padded vertical segment"> + <div class="ui middle aligned two column grid"> + <div class="column"> + <i class="huge circular inverted yellow object ungroup icon"></i> + </div> + <div class="column"> + <h3 class="ui inverted header">Segment your data</h3> + <div class="feature-description"> + Retrieve on the cases or fields that you want. + </div> + </div> + </div> + </div> + + <div class="ui basic padded vertical segment"> + <div class="ui middle aligned two column grid"> + <div class="column"> + <i class="huge circular inverted red line chart icon"></i> + </div> + <div class="column"> + <h3 class="ui inverted header">Compute gross usage trends</h3> + <div class="feature-description"> + Distill comes with built-in statistics libraries so that you can see how much your application is being used and which elements users rely on most. + </div> + </div> + </div> + </div> + + <div class="ui basic padded vertical segment"> + <div class="ui middle aligned two column grid"> + <div class="column"> + <i class="huge circular inverted green ordered list icon"></i> + </div> + <div class="column"> + <h3 class="ui inverted header">Model workflow</h3> + <div class="feature-description"> + Distill comes with built in graph libraries for studying how user behaviors are sequenced in time allowing you to explore models of how user behavior unfolds over time. + </div> + </div> + </div> + </div> + + </div> +</div> + + + + +<div class="ui very padded vertical segment"> + <div class="ui center aligned text container"> + <h2 class="ui header"> + Ready to try Distill? + </h2> + <a class="ui big blue button" href="/releases"> + Get the Release + </a> + <a class="ui big yellow button" href="/docs/distill/"> + Read the Docs + </a> + </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/855d3ab1/_site/docs/contributing.html ---------------------------------------------------------------------- diff --git a/_site/docs/contributing.html b/_site/docs/contributing.html new file mode 100644 index 0000000..83e43cf --- /dev/null +++ b/_site/docs/contributing.html @@ -0,0 +1,334 @@ +<!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>Contributing</title> + <meta name="description" content="First, thank you for contributing to Apache SensSoft!"> + + <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/contributing.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="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/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</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">Contributing</h2> + <p>First, thank you for contributing to Apache SensSoft!</p> + +<p>There are certain procedures that must be followed for all contributions. These procedures are necessary to allow us to allocate resources for reviewing and testing your contribution, as well as to communicate effectively with you during the review process.</p> + +<p>See individual product guides for product-specific information on getting started as a contributor, setup and testing, code style, etc.</p> + +<p>To report a bug or other issue, simply create an issue in JIRA, as described in Step 1 below.</p> + +<h4 id="1-create-an-issue-in-jira">1. Create an issue in JIRA</h4> + +<p>All changes to Apache Distill must have a corresponding issue in <a href="https://issues.apache.org/jira/browse/SENSSOFT";>JIRA</a> so the change can be properly tracked. If you do not already have an account on Apache JIRA, you will need to create one before creating your new issue.</p> + +<h4 id="2-make-and-test-your-changes-locally">2. Make and test your changes locally</h4> + +<p>The Apache SensSoft source code is maintained in <a href="https://git-wip-us.apache.org/repos/asf?s=senssoft";>several git repositories</a> hosted by Apache. These repositories are mirrored and more easily available <a href="https://github.com/apache?q=senssoft";>on GitHub</a>. To make your changes, fork the appropriate GitHub repository and make commits to a topic branch in your fork. Commits should be made in logical units and must reference the JIRA issue number:</p> +<div class="language-shell highlighter-rouge"><pre class="highlight"><code> git commit -m <span class="s2">"#SENSSOFT-123: #High-level message describing the changes."</span> +</code></pre> +</div> +<p>Avoid commits which cover multiple, distinct goals that could (and should) be handled separately. If you do not already have an account on JIRA, you will need to create one to claim an issue, discuss development, or report results.</p> + +<h4 id="3-submit-your-changes-via-a-pull-request-on-github">3. Submit your changes via a pull request on GitHub</h4> + +<p>Once your changes are ready, submit them by creating a pull request for the corresponding topic branch you created when you began working on your changes. The core team will then review your changes and, if they pass review, your changes will be merged into the primary Apache-hosted repos.</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/855d3ab1/_site/docs/distill/analytics.html ---------------------------------------------------------------------- diff --git a/_site/docs/distill/analytics.html b/_site/docs/distill/analytics.html new file mode 100644 index 0000000..402621e --- /dev/null +++ b/_site/docs/distill/analytics.html @@ -0,0 +1,404 @@ +<!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 Analytics</title> + <meta name="description" content="Graph Analytics"> + + <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/analytics.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/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</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 Analytics</h2> + <h3 id="graph-analytics">Graph Analytics</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">algorithms</span><span class="o">.</span><span class="n">graphs</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">GraphAnalytics</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Bases:</strong> object</p> +</blockquote> + +<blockquote> + <p>Distillâs graph analytics package. Apply graph algorithms to User Ale log data segmented with Stout.</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">foo</span><span class="p">()</span> +</code></pre> + </div> +</blockquote> + +<h3 id="statistics-package">Statistics Package</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">algorithms</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">hist</span><span class="o">.</span><span class="n">Hist</span> +</code></pre> + </div> +</blockquote> + +<blockquote> + <p><strong>Bases:</strong> object</p> +</blockquote> + +<blockquote> + <p>Distillâs statistics package. Apply statistical algorithms to User Ale log data segmented with Stout. Need to query/filter by session or user id.</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">get_value</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">histogram</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">q</span><span class="o">=</span><span class="s">''</span><span class="p">)</span> +</code></pre> + </div> + <p>Only works on numerical data.</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">terms</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">q</span><span class="o">=</span><span class="s">''</span><span class="p">)</span> +</code></pre> + </div> + <p>Group by field (find all elements )</p> +</blockquote> + +<blockquote> + + <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">static</span> <span class="n">unique_terms</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">q</span><span class="o">=</span><span class="s">''</span><span class="p">)</span> +</code></pre> + </div> + <p>Aggregate the number of unique terms in a field. Missing values are counted and marked as âN/Aâ.</p> +</blockquote> + +<blockquote> + <p><strong>Todo:</strong> Need to incorporate QueryBuilder library instead of manually generating queries.</p> +</blockquote> + +<blockquote> + <p><strong>Parameters:</strong></p> + <ul> + <li>app â [string] application name</li> + <li>app_type â [string] application type</li> + <li>field â [string] field to search against for unique values</li> + <li>size â [int] the top size terms returned in the result. Default value is 10.</li> + <li>min_hits â [int] return tags which have been found in min_hits or more. Default value is 1.</li> + </ul> +</blockquote> + +<blockquote> + <p><strong>Returns:</strong></p> + <ul> + <li>[dict] dictionary of results</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/855d3ab1/_site/docs/distill/api.html ---------------------------------------------------------------------- diff --git a/_site/docs/distill/api.html b/_site/docs/distill/api.html new file mode 100644 index 0000000..adb86a7 --- /dev/null +++ b/_site/docs/distill/api.html @@ -0,0 +1,335 @@ +<!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>API Documentation</title> + <meta name="description" content="Apache Distill HTTP Client RESTful Endpoints"> + + <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/api.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/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</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">API Documentation</h2> + <h3 id="apache-distill-http-client"><a href="/docs/distill/http/">Apache Distill HTTP Client</a></h3> +<ul> + <li>RESTful Endpoints</li> +</ul> + +<h3 id="apache-distill-analytics"><a href="/docs/distill/analytics/">Apache Distill Analytics</a></h3> +<ul> + <li>Graph Analytics</li> + <li>Statistics Package</li> +</ul> + +<h3 id="apache-distill-models"><a href="/docs/distill/models/">Apache Distill Models</a></h3> +<ul> + <li>Brew Interface</li> + <li>Stout Interface</li> + <li>UserAle Interface</li> +</ul> + +<h3 id="apache-distill-utilities"><a href="/docs/distill/utilities/">Apache Distill Utilities</a></h3> +<ul> + <li>Query Builder</li> + <li>Exception Handling</li> + <li>Validation Library</li> +</ul> + + </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>
