Skip to content

Commit

Permalink
Info on DDT and TAD.
Browse files Browse the repository at this point in the history
  • Loading branch information
brittainhard committed Nov 9, 2015
1 parent 9a3dd80 commit 890ecbd
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 9 deletions.
13 changes: 8 additions & 5 deletions docs/source/crawler_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ Crawler Control Buttons

These are the buttons available for Ache:

.. image:: _static/img/ache-buttons.png
.. image:: _static/img/ache-buttons.png

These are the buttons available for Nutch:

.. image:: _static/img/nutch-buttons.png
.. image:: _static/img/nutch-buttons.png

Options Button
--------------
Expand All @@ -54,9 +54,9 @@ Start Button

Stop Button
-----------
Symbolized by the "stop" button. Stops the crawl.
Symbolized by the "stop" button. Stops the crawl.

In the case of Ache, the crawler stops immediately. In the case of Nutch, the crawler stops after it has finished the current round. This is in order to prevent data corruption that can occur when killing the Nutch process.
In the case of Ache, the crawler stops immediately. In the case of Nutch, the crawler stops after it has finished the current round. This is in order to prevent data corruption that can occur when killing the Nutch process.

Restart Button
--------------
Expand All @@ -70,9 +70,12 @@ Get Crawl Log

CCA Export
----------

This button is Nutch only. It allows you to export your crawl data into the CCA format.

Rounds Input
------------
Nutch only. This allows you to specify how many rounds you want the crawl to run. You can press the stop button at any time and it will stop when it is done with the current round.

Crawl Settings
==============
The crawl settings page allows you to delete the crawl, as well as change the name or description of the crawl. It is accessed by clicking the "pencil" icon next to the name of the crawl.
Expand Down
33 changes: 29 additions & 4 deletions docs/source/dev_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Nutch Visualizations

Nutch visualizations are not enabled by default. Nutch visualizations require RabbitMQ, and the method for installing RabbitMQ varies depending on the operating system. RabbitMQ can be installed via Homebrew on Mac, and apt-get on Debian systems. More information on how to install RabbitMQ, read `this page <https://www.rabbitmq.com/download.html>`_. Note: You may also need to change the below command to `sudo rabbitmq-server`, depending on how RabbitMQ is installed on your system and the permissions of the current user.

To enable Bokeh visualizations for Nutch, change ``autostart=false`` to ``autostart=true`` for both of these directives in source/supervisord.conf, and then kill and restart supervisor.
To enable Bokeh visualizations for Nutch, change ``autostart=false`` to ``autostart=true`` for both of these directives in `source/supervisord.conf`, and then kill and restart supervisor.

.. code-block:: html

Expand All @@ -74,7 +74,32 @@ Nutch Visualizations
-autostart=false
+autostart=true

Domain Discovery Tool
---------------------
Domain Discovery Tool (DDT)
---------------------------

Domain Discovery Tool can be installed as a conda package. Simply run `conda install ddt` to download the package for DDT.

Like with Nutch visualizations, to enable DDT, change the directive in `source/supervisord`.

.. code-block:: html

[program:ddt]
command=ddt
priority=5
-autostart=false
+autostart=false

Temporal Anomaly Detection (TAD)
--------------------------------

TAD does not currently have a conda package. Like the Nutch visualizations, it also has a RabbitMQ dependency. For instructions on installing TAD, visit the `github repository <https://github.com/autonlab/tad>`_.

Like DDT and Nutch Visualizations, you also have to change the supervisord directive.

.. code-block:: html

Domain
[program:tad]
command=tad
priority=5
-autostart=false
+autostart=false

0 comments on commit 890ecbd

Please sign in to comment.