Debian Codegraph @

doc/_templates/index.html

raw
1 {% extends "layout.html" %}
2 {% set title = _('Overview') %}
3 {% block body %}
4 <h1>Welcome to the home of Flent</h1>
5 <div class="screenshot">
6 <img src="_static/flent-screenshot.png" alt="Screenshot of the interactive Flent GUI.">
7 </div>
8 <p>Flent is a network benchmarking tool which allows you to:</p>
9 <ul class="front">
10 <li>Easily
11 <strong>run network tests</strong>
12 composing multiple well-known benchmarking tools into aggregate, repeatable test runs.</li>
13 <li><strong>Explore</strong>
14 your test data through the interactive GUI and extensive plotting capabilities.</li>
15 <li><strong>Combine and aggregate</strong>
16 data series and produce publication quality graphs.</li>
17 <li><strong>Capture metadata</strong>
18 from local and remote hosts and store it along with the plot data.</li>
19 <li><strong>Collect secondary data series</strong>
20 such as CPU usage, WiFi, qdisc and TCP socket statistics and plot it with the main dataset.</li>
21 <li>Specify batch experiment runs to
22 <strong>completely automate your testing</strong>
23 regime.</li>
24 </ul>
25 <div style="clear: both;"></div>
26 <p>Flent is written in Python and wraps well-known network benchmarking tools (such as
27 <a href="http://netperf.org">netperf</a>
28 and
29 <a href="https://sourceforge.net/p/iperf2">iperf</a>) into aggregate, repeatable tests, such as a number of
30 <a href="https://www.bufferbloat.net/projects/bloat/wiki/Tests_for_Bufferbloat/">tests for Bufferbloat</a>.</p>
31 <p>There's a
32 <a href="flent-the-flexible-network-tester.pdf">short paper (pdf)</a>
33 and a
34 <a href="https://blog.tohojo.dk/2017/04/the-story-of-flent-the-flexible-network-tester.html">blog post</a>
35 describing some of the design goals of Flent.</p>
36 <h2>Getting started</h2>
37 <p>Install Flent as per the instructions below, then see
38 <a href="intro.html#quick-start">the Quick-start section</a>
39 to get going.</p>
40 <p>For more information, see
41 <a href="contents.html">the full documentation</a>
42 or
43 <a href="search.html">search</a>
44 for specific content.</p>
45 <h2>Installing Flent</h2>
46 <p>Installing Flent can be done in several ways, depending on your operating system:</p>
47 <ul>
48 <li><strong>Arch Linux:</strong>
49 Install Flent from
50 <a href="https://aur.archlinux.org/packages/flent">the AUR</a>.</li>
51 <li><strong>Debian and Ubuntu:</strong>
52 <code class="docutils literal"><span class="pre">apt install flent</span></code>. To install netperf,
53 <a href="https://wiki.debian.org/SourcesList">enable the non-free repository</a>.</li>
54 <li><strong>Fedora:</strong>
55 <code class="docutils literal"><span class="pre">dnf install flent</span></code>.</li>
56 <li><strong>Gentoo:</strong>
57 <code class="docutils literal"><span class="pre">emerge net-analyzer/flent</span></code>.</li>
58 <li><strong>Nix:</strong>
59 Flent is available in nixpkgs through the
60 <code class="docutils literal"><span class="pre">flent</span></code>
61 attribute.</li>
62 <li><strong>Ubuntu pre-18.04:</strong>
63 Add the
64 <a href="https://launchpad.net/~tohojo/+archive/ubuntu/flent">tohojo/flent PPA</a>.</li>
65 <li><strong>Other Linux</strong>
66 Install from the
67 <a href="https://pypi.python.org/pypi/flent">Python Package Index</a>:
68 <code class="docutils literal"><span class="pre">pip install flent</span></code></li>
69 <li><strong>FreeBSD:</strong>
70 <code class="docutils literal"><span class="pre">pkg install flent</span></code>
71 to install the package or
72 <code class="docutils literal"><span class="pre">cd /usr/ports/net/flent</span></code>
73 to install the port.</li>
74 <li><strong>OSX with Macbrew:</strong>
75 See install instructions in the
76 <a href="intro.html#installing-flent">Installing flent</a>
77 section</li>
78 </ul>
79 <h2>Get involved</h2>
80 <p>Getting involved is easy:</p>
81 <ul>
82 <li>Browse the source code or issue tracker
83 <a href="https://github.com/tohojo/flent">on GitHub</a></li>
84 <li>Subscribe to the
85 <a href="https://lists.flent.org/postorius/lists/">mailing lists</a></li>
86 </ul>
87 {% endblock %}