Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc tweaks #313

Merged
merged 5 commits into from
Dec 9, 2024
Merged

Doc tweaks #313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57275fb
Fix incorrect html in index.html
mmlb Dec 5, 2024
c647d07
Fix D-ITG sub-section case consistency
mmlb Dec 5, 2024
a6252c3
Sync install docs content
mmlb Dec 5, 2024
5a5bc3b
Add nix installation instructions.
mmlb Dec 5, 2024
db6882f
Reformat html templates
mmlb Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://aur.archlinux.org/packages/flent>`_.

- **Debian and Ubuntu:**

.. code-block:: bash
Expand All @@ -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 <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_.
.. code-block:: bash

- **Arch Linux:**
emerge net-analyzer/flent

Install Flent from `the AUR <https://aur.archlinux.org/packages/flent>`_.
- **Nix:**

Flent is available in nixpkgs through the `flent` attribute.

- **Ubuntu pre-18.04:**

Add the `tohojo/flent PPA <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_.

- **Other Linux:**

Expand Down
110 changes: 67 additions & 43 deletions doc/_templates/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,61 +3,85 @@
{% block body %}
<h1>Welcome to the home of Flent</h1>
<div class="screenshot">
<img src="_static/flent-screenshot.png" alt="Screenshot of the interactive
Flent GUI." />
<img src="_static/flent-screenshot.png" alt="Screenshot of the interactive Flent GUI.">
</div>
<p>Flent is a network benchmarking tool which allows you to:</p>
<ul class="front">
<li>Easily <strong>run network tests</strong> composing multiple well-known benchmarking tools into
aggregate, repeatable test runs.</li>
<li><strong>Explore</strong> your test data through the interactive GUI and extensive plotting
capabilities.</li>
<li><strong>Combine and aggregate</strong> data series and produce publication quality graphs.</li>
<li><strong>Capture metadata</strong> from local and remote hosts and store it along with the
plot data.</li>
<li><strong>Collect secondary data series</strong> such as CPU usage, WiFi, qdisc and TCP socket
statistics and plot it with the main dataset.</li>
<li>Specify batch experiment runs to <strong>completely automate your
testing</strong> regime.</li>
<li>Easily
<strong>run network tests</strong>
composing multiple well-known benchmarking tools into aggregate, repeatable test runs.</li>
<li><strong>Explore</strong>
your test data through the interactive GUI and extensive plotting capabilities.</li>
<li><strong>Combine and aggregate</strong>
data series and produce publication quality graphs.</li>
<li><strong>Capture metadata</strong>
from local and remote hosts and store it along with the plot data.</li>
<li><strong>Collect secondary data series</strong>
such as CPU usage, WiFi, qdisc and TCP socket statistics and plot it with the main dataset.</li>
<li>Specify batch experiment runs to
<strong>completely automate your testing</strong>
regime.</li>
</ul>

<div style="clear: both;"></div>
<p>Flent is written in Python and wraps well-known network benchmarking tools
(such as <a href="http://netperf.org">netperf</a>
and <a href="https://sourceforge.net/p/iperf2">iperf</a>) into aggregate,
repeatable tests, such as a number
of <a href="https://www.bufferbloat.net/projects/bloat/wiki/Tests_for_Bufferbloat/">tests
for Bufferbloat</a>.</p>
<p>There's a <a href="flent-the-flexible-network-tester.pdf">short paper
(pdf)</a> and
a <a href="https://blog.tohojo.dk/2017/04/the-story-of-flent-the-flexible-network-tester.html">blog
post</a> describing some of the design goals of Flent.</p>

<p>Flent is written in Python and wraps well-known network benchmarking tools (such as
<a href="http://netperf.org">netperf</a>
and
<a href="https://sourceforge.net/p/iperf2">iperf</a>) into aggregate, repeatable tests, such as a number of
<a href="https://www.bufferbloat.net/projects/bloat/wiki/Tests_for_Bufferbloat/">tests for Bufferbloat</a>.</p>
<p>There's a
<a href="flent-the-flexible-network-tester.pdf">short paper (pdf)</a>
and a
<a href="https://blog.tohojo.dk/2017/04/the-story-of-flent-the-flexible-network-tester.html">blog post</a>
describing some of the design goals of Flent.</p>
<h2>Getting started</h2>
<p>Install Flent as per the instructions below, then see <a
href="intro.html#quick-start">the Quick-start section</a> to get going</a>.</p>
<p>For more information, see <a href="contents.html">the full documentation<a>
or <a href="search.html">search</a> for specific content.</p>
<p>Install Flent as per the instructions below, then see
<a href="intro.html#quick-start">the Quick-start section</a>
to get going.</p>
<p>For more information, see
<a href="contents.html">the full documentation</a>
or
<a href="search.html">search</a>
for specific content.</p>
<h2>Installing Flent</h2>
<p>Installing Flent can be done in several ways, depending on your operating system:</p>
<ul>
<li><strong>Debian and Ubuntu:</strong> <code class="docutils
literal"><span class="pre">apt install flent</span></code>. To install
netperf, <a href="https://wiki.debian.org/SourcesList">enable the non-free repository</a>.</li>
<li><strong>Fedora:</strong> <code class="docutils literal"><span class="pre">dnf install flent</span></code>.</li>
<li><strong>Gentoo:</strong> <code class="docutils literal"><span class="pre">emerge net-analyzer/flent</span></code>.</li>
<li><strong>Ubuntu pre-18.04:</strong> Add the <a
href="https://launchpad.net/~tohojo/+archive/ubuntu/flent">tohojo/flent PPA</a>.</li>
<li><strong>Arch Linux:</strong> Install Flent from <a href="https://aur.archlinux.org/packages/flent">the AUR</a>.</li>
<li><strong>FreeBSD:</strong> <code class="docutils literal"><span class="pre">pkg install flent</span></code> to install the package or <code class="docutils literal"><span class="pre">cd /usr/ports/net/flent</span></code> to install the port.</li>
<li><strong>Other Linux and OSX with Macbrew:</strong> Install from the <a href="https://pypi.python.org/pypi/flent">Python
Package Index</a>: <code class="docutils literal"><span class="pre">pip install flent</span></code></li>
<li><strong>Arch Linux:</strong>
Install Flent from
<a href="https://aur.archlinux.org/packages/flent">the AUR</a>.</li>
<li><strong>Debian and Ubuntu:</strong>
<code class="docutils literal"><span class="pre">apt install flent</span></code>. To install netperf,
<a href="https://wiki.debian.org/SourcesList">enable the non-free repository</a>.</li>
<li><strong>Fedora:</strong>
<code class="docutils literal"><span class="pre">dnf install flent</span></code>.</li>
<li><strong>Gentoo:</strong>
<code class="docutils literal"><span class="pre">emerge net-analyzer/flent</span></code>.</li>
<li><strong>Nix:</strong>
Flent is available in nixpkgs through the
<code class="docutils literal"><span class="pre">flent</span></code>
attribute.</li>
<li><strong>Ubuntu pre-18.04:</strong>
Add the
<a href="https://launchpad.net/~tohojo/+archive/ubuntu/flent">tohojo/flent PPA</a>.</li>
<li><strong>Other Linux</strong>
Install from the
<a href="https://pypi.python.org/pypi/flent">Python Package Index</a>:
<code class="docutils literal"><span class="pre">pip install flent</span></code></li>
<li><strong>FreeBSD:</strong>
<code class="docutils literal"><span class="pre">pkg install flent</span></code>
to install the package or
<code class="docutils literal"><span class="pre">cd /usr/ports/net/flent</span></code>
to install the port.</li>
<li><strong>OSX with Macbrew:</strong>
See install instructions in the
<a href="intro.html#installing-flent">Installing flent</a>
section</li>
</ul>
<h2>Get involved</h2>
<p>Getting involved is easy:</p>
<ul>
<li>Browse the source code or issue tracker <a
href="https://github.com/tohojo/flent">on GitHub</a></li>
<li>Subscribe to the <a href="https://lists.flent.org/postorius/lists/">mailing lists</a></li>
<li>Browse the source code or issue tracker
<a href="https://github.com/tohojo/flent">on GitHub</a></li>
<li>Subscribe to the
<a href="https://lists.flent.org/postorius/lists/">mailing lists</a></li>
</ul>
{% endblock %}
2 changes: 1 addition & 1 deletion doc/misc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
12 changes: 8 additions & 4 deletions doc/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://aur.archlinux.org/packages/flent>`_.

- **Debian and Ubuntu:**

.. code-block:: bash
Expand All @@ -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 <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_.
Flent is available in nixpkgs through the `flent` attribute.

- **Arch Linux:**
- **Ubuntu pre-18.04:**

Install Flent from `the AUR <https://aur.archlinux.org/packages/flent>`_.
Add the `tohojo/flent PPA <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_.

- **Other Linux:**

Expand Down
Loading