diff --git a/README.rst b/README.rst index 0b6a48bb..b64c63f7 100644 --- a/README.rst +++ b/README.rst @@ -11,6 +11,10 @@ Installing Flent Installing Flent can be done in several ways, depending on your operating system: +- **Arch Linux:** + + Install Flent from `the AUR `_. + - **Debian and Ubuntu:** .. code-block:: bash @@ -23,13 +27,19 @@ Installing Flent can be done in several ways, depending on your operating system dnf install flent -- **Ubuntu pre-18.04:** +- **Gentoo:** - Add the `tohojo/flent PPA `_. + .. code-block:: bash -- **Arch Linux:** + emerge net-analyzer/flent - Install Flent from `the AUR `_. +- **Nix:** + + Flent is available in nixpkgs through the `flent` attribute. + +- **Ubuntu pre-18.04:** + + Add the `tohojo/flent PPA `_. - **Other Linux:** diff --git a/doc/_templates/index.html b/doc/_templates/index.html index 59aad80c..39527c05 100644 --- a/doc/_templates/index.html +++ b/doc/_templates/index.html @@ -3,61 +3,85 @@ {% block body %}

Welcome to the home of Flent

- Screenshot of the interactive - Flent GUI. + Screenshot of the interactive Flent GUI.

Flent is a network benchmarking tool which allows you to:

    -
  • Easily run network tests composing multiple well-known benchmarking tools into - aggregate, repeatable test runs.
    • -
  • Explore your test data through the interactive GUI and extensive plotting - capabilities.
    • -
  • Combine and aggregate data series and produce publication quality graphs.
    • -
  • Capture metadata from local and remote hosts and store it along with the - plot data.
    • -
  • Collect secondary data series such as CPU usage, WiFi, qdisc and TCP socket - statistics and plot it with the main dataset.
    • -
  • Specify batch experiment runs to completely automate your - testing regime.
    • +
  • Easily + run network tests + composing multiple well-known benchmarking tools into aggregate, repeatable test runs.
    • +
  • Explore + your test data through the interactive GUI and extensive plotting capabilities.
    • +
  • Combine and aggregate + data series and produce publication quality graphs.
    • +
  • Capture metadata + from local and remote hosts and store it along with the plot data.
    • +
  • Collect secondary data series + such as CPU usage, WiFi, qdisc and TCP socket statistics and plot it with the main dataset.
    • +
  • Specify batch experiment runs to + completely automate your testing + regime.
-
-

Flent is written in Python and wraps well-known network benchmarking tools - (such as netperf - and iperf) into aggregate, - repeatable tests, such as a number - of tests - for Bufferbloat.

-

There's a short paper - (pdf) and - a blog - post describing some of the design goals of Flent.

- +

Flent is written in Python and wraps well-known network benchmarking tools (such as + netperf + and + iperf) into aggregate, repeatable tests, such as a number of + tests for Bufferbloat.

+

There's a + short paper (pdf) + and a + blog post + describing some of the design goals of Flent.

Getting started

-

Install Flent as per the instructions below, then see the Quick-start section to get going.

-

For more information, see the full documentation -or search for specific content.

+

Install Flent as per the instructions below, then see + the Quick-start section + to get going.

+

For more information, see + the full documentation + or + search + for specific content.

Installing Flent

Installing Flent can be done in several ways, depending on your operating system:

    -
  • Debian and Ubuntu: apt install flent. To install - netperf, enable the non-free repository.
    • -
  • Fedora: dnf install flent.
    • -
  • Gentoo: emerge net-analyzer/flent.
    • -
  • Ubuntu pre-18.04: Add the tohojo/flent PPA.
    • -
  • Arch Linux: Install Flent from the AUR.
    • -
  • FreeBSD: pkg install flent to install the package or cd /usr/ports/net/flent to install the port.
    • -
  • Other Linux and OSX with Macbrew: Install from the Python - Package Index: pip install flent
    • +
  • Arch Linux: + Install Flent from + the AUR.
    • +
  • Debian and Ubuntu: + apt install flent. To install netperf, + enable the non-free repository.
    • +
  • Fedora: + dnf install flent.
    • +
  • Gentoo: + emerge net-analyzer/flent.
    • +
  • Nix: + Flent is available in nixpkgs through the + flent + attribute.
    • +
  • Ubuntu pre-18.04: + Add the + tohojo/flent PPA.
    • +
  • Other Linux + Install from the + Python Package Index: + pip install flent
    • +
  • FreeBSD: + pkg install flent + to install the package or + cd /usr/ports/net/flent + to install the port.
    • +
  • OSX with Macbrew: + See install instructions in the + Installing flent + section

Get involved

Getting involved is easy:

{% endblock %} diff --git a/doc/misc.rst b/doc/misc.rst index 897d2632..9d175989 100644 --- a/doc/misc.rst +++ b/doc/misc.rst @@ -1,7 +1,7 @@ Misc info ========= -Running Tests With The D-ITG Tool +Running tests with the D-ITG tool --------------------------------- This version of flent has experimental support for running and parsing the diff --git a/doc/quickstart.rst b/doc/quickstart.rst index c7dd54f5..b3d37849 100644 --- a/doc/quickstart.rst +++ b/doc/quickstart.rst @@ -3,6 +3,10 @@ Installing Flent Installing Flent can be done in several ways, depending on your operating system: +- **Arch Linux:** + + Install Flent from `the AUR `_. + - **Debian and Ubuntu:** .. code-block:: bash @@ -21,13 +25,13 @@ Installing Flent can be done in several ways, depending on your operating system emerge net-analyzer/flent -- **Ubuntu pre-18.04:** +- **Nix:** - Add the `tohojo/flent PPA `_. + Flent is available in nixpkgs through the `flent` attribute. -- **Arch Linux:** +- **Ubuntu pre-18.04:** - Install Flent from `the AUR `_. + Add the `tohojo/flent PPA `_. - **Other Linux:**