Skip to content
This repository has been archived by the owner on Mar 2, 2022. It is now read-only.

Commit

Permalink
Explain installation and running in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
DonnchaC committed Sep 19, 2016
1 parent 357844f commit 152c422
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion README.rst
Expand Up @@ -4,14 +4,57 @@ BWScanner
.. image:: https://travis-ci.org/TheTorProject/bwscanner.svg?branch=develop
:target: https://travis-ci.org/TheTorProject/bwscanner

.. image:: https://coveralls.io/repos/github/TheTorProject/bwscanner/badge.svg?branch=develop&reload=1
.. image:: https://coveralls.io/repos/github/TheTorProject/bwscanner/badge.svg?branch=develop&reload=1
:target: https://coveralls.io/github/TheTorProject/bwscanner?branch=develop

BWScanner is a tool for measuring the bandwidth of Tor relays. Its aim is to replace the existing Torflow system.

This project is still under active development and is not ready for active use or production deployment yet.


Installation
------------

The bandwidth scanner and its dependencies can be installed as follows:

.. code:: bash
git clone https://github.com/TheTorProject/bwscanner.git
cd bwscanner
python setup.py install
Running
-------

After installation the ``bwscan`` tool should be available in your path. This tool has a number of subcommands for running scans and for aggregating the collected data for use by the bandwidth authorities.

Collecting bandwidth measurements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``--partitions`` option can be used to split the consensus into subsets of relays which can be scanned on different machines. The results can later be combined during the measurement aggregation step.

.. code:: bash
bwscan scan
Aggregating scan results
~~~~~~~~~~~~~~~~~~~~~~~~

This command will aggregate the data for the latest five completed scans.

.. code:: bash
bwscan aggregate -n 5
The final aggregation script is not yet integrated with the CLI. It should be called with the path to the directory containing the most recent aggregated data:

.. code:: bash
python scripts/aggregate.py ~/.config/bwscanner/measurements/1474278776
Development
-----------

Expand Down

0 comments on commit 152c422

Please sign in to comment.