File	Date	Author	Commit
animate	2017-04-12	grenville armitage	[12018d] Updated teaplot (fab animate) to version 0.2 wi...
docs	2018-02-09	grenville armitage	[b8b8b0] Add doc pdfs locally, update README, AUTHORS an...
example_configs	2018-02-07	grenville armitage	[f112d1] Substantial updates to documentation for cover ...
tools	2018-02-09	grenville armitage	[d26c89] Remove unused pktloss.py
.hgeol	2017-04-13	grenville armitage	[7c5449] Added .hgeol to normalise .lyx line endings whe...
.hgtags	2018-02-10	grenville armitage	[51c6af] Added tag v1.1 for changeset e1d110a7fd4e
ACKNOWLEDGMENTS	2015-09-29	Sebastian Zander	[f0e89c] Modiffied acknowledgements
AUTHORS	2018-02-09	grenville armitage	[b8b8b0] Add doc pdfs locally, update README, AUTHORS an...
COPYING	2016-07-05	grenville armitage	[21b454] Patch fabfile.py to import 'fab animate' functi...
ChangeLog	2018-02-10	grenville armitage	[090dc3] Updated changelog
INSTALL	2018-02-09	grenville armitage	[b8b8b0] Add doc pdfs locally, update README, AUTHORS an...
README	2018-02-09	grenville armitage	[b8b8b0] Add doc pdfs locally, update README, AUTHORS an...
TODO	2018-02-09	grenville armitage	[a8fa01] Update TODO
VERSION	2018-02-09	grenville armitage	[4db88e] Update Changelog and VERSION
analyse.py	2018-02-07	grenville armitage	[ccc2b1] Fix typo in ttprobe handling
analyse_owd.py	2018-02-07	grenville armitage	[1920bf] New {extract,analyse}_owd and new {extract,anal...
analysecmpexp.py	2018-02-07	grenville armitage	[1920bf] New {extract,analyse}_owd and new {extract,anal...
analyseutil.py	2018-02-07	grenville armitage	[1920bf] New {extract,analyse}_owd and new {extract,anal...
backupconfig.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
bgproc.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
clockoffset.py	2018-02-07	grenville armitage	[1920bf] New {extract,analyse}_owd and new {extract,anal...
combine_graphs.sh	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
conf-macaddr_xx:xx:xx:xx:xx:xx.ipxe.in	2015-05-21	Sebastian Zander	[3178e3] Initial commit
convert_config_addr.sh	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
doxygen.config.in	2015-05-21	Sebastian Zander	[3178e3] Initial commit
env_parsing.R	2016-06-03	Sebastian Zander	[60196b] Prepended a TC_ to all evironment variables use...
experiment.py	2018-02-02	grenville armitage	[75624d] Ticket#14, improve how experiment run time is c...
fabfile.py	2018-02-07	grenville armitage	[066d6f] Bug fix handling of noclients_game in start_fps...
filefinder.py	2015-11-05	Sebastian Zander	[d88476] Changes to make analysis work in directories wi...
flowcache.py	2016-06-06	Sebastian Zander	[88f29c] Do not create entries with empty flow list in c...
generate_http_content.sh.in	2015-05-21	Sebastian Zander	[3178e3] Initial commit
generate_http_incast_content.sh.in	2015-05-21	Sebastian Zander	[3178e3] Initial commit
get_hg_info.sh	2015-05-21	Sebastian Zander	[ac150f] enable keywords
getfile.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
hostint.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
hostmac.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
hostsetup.py	2017-02-20	gja	[3b0862] Commit support for AQM in FreeBSD bottleneck, p...
hosttype.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
internalutil.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
kill_iperf.sh	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
lighttpd_CYGWIN.conf.in	2015-05-21	Sebastian Zander	[3178e3] Initial commit
lighttpd_FreeBSD.conf.in	2017-04-05	grenville armitage	[7d73e5] Add support for generating DASH traffic with da...
lighttpd_Linux.conf.in	2017-04-05	grenville armitage	[7d73e5] Add support for generating DASH traffic with da...
list-OSes.sh	2015-05-25	Sebastian Zander	[99723e] Changed default experiment ID prefix to: 'exp_'...
loggers.py	2018-05-31	grenville armitage	[51a44b] New config.py options:
make_doxy.sh	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
make_tar.sh	2018-02-10	grenville armitage	[e1d110] Tweak make_tar.sh to build from correct repo br...
nameipmap.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
nginx_FreeBSD.conf.in	2017-12-11	grenville armitage	[f3e7ae] add missing nginx config templates
nginx_Linux.conf.in	2017-12-11	grenville armitage	[f3e7ae] add missing nginx config templates
pktgen.sh	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
plot.py	2016-06-03	Sebastian Zander	[60196b] Prepended a TC_ to all evironment variables use...
plot_bursts.R	2018-01-23	Sebastian Zander	[27f490] Optimised plotting by avoiding the double plott...
plot_cmp_experiments.R	2018-01-23	Sebastian Zander	[27f490] Optimised plotting by avoiding the double plott...
plot_contour.R	2016-06-03	Sebastian Zander	[60196b] Prepended a TC_ to all evironment variables use...
plot_dash_goodput.R	2018-01-23	Sebastian Zander	[27f490] Optimised plotting by avoiding the double plott...
plot_func.R	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
plot_time_series.R	2018-01-23	Sebastian Zander	[27f490] Optimised plotting by avoiding the double plott...
point_thinning.R	2016-06-03	Sebastian Zander	[60196b] Prepended a TC_ to all evironment variables use...
routersetup.py	2017-02-20	gja	[3b0862] Commit support for AQM in FreeBSD bottleneck, p...
run.sh	2015-05-25	Sebastian Zander	[99723e] Changed default experiment ID prefix to: 'exp_'...
run_resume.sh	2015-05-25	Sebastian Zander	[99723e] Changed default experiment ID prefix to: 'exp_'...
runbg.py	2015-09-28	Sebastian Zander	[94ce51] Added ttprobe logger support
runbg_wrapper.sh	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
sanitychecks.py	2017-12-09	grenville armitage	[acbc2c] Add support for launching an nginx server (jtku...
sourcefilter.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
tcp_comparison.sh	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
tcp_comparison_allonone.sh	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
trafficgens.py	2018-02-07	grenville armitage	[066d6f] Bug fix handling of noclients_game in start_fps...
util.py	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...
version.py	2015-05-26	Sebastian Zander	[ebb080] Fixed get_version task so it works with mercurial
web10g_logger.sh	2015-05-25	Sebastian Zander	[e7ea17] Changed Sebastian's email to gmx address, excep...

Read Me

TEACUP (TCP Experiment Automation Controlled Using Python) README 
=================================================================

$Id$

ACKNOWLEDGMENTS
---------------

See ./ACKNOWLEDGEMENTS

INTRODUCTION
------------

This README is for TEACUP Version 1.1

This README provides a brief overview on where to find information on setting
up a TEACUP testbed, running experiments and analysing the results of experiments.

The project website is https://sourceforge.net/projects/teacup


TEACUP TESTBED
--------------

TEACUP makes some assumptions on the setup of the testbed and hosts. In order
to use all of TEACUP's functions one needs to install a testbed similar to the
one described briefly in INSTALL and described in more detail in:
http://caia.swin.edu.au/reports/150210C/CAIA-TR-150210C.pdf

A minimum setup for TEACUP does not require all the functionality
described in CAIA-TR-150210C.pdf. The minimum setup is:
- Two subnets separated by one router, with at least one host in each
  subnet acting as traffic source/sink;
- Hosts must run Linux, FreeBSD, Windows 7 or Mac OS X, the router must run
  Linux (preferably) or FreeBSD;
- Each host needs an extra network interface connected to a separate control 
  network;
- A control host that runs TEACUP to control the testbed via the control
  network;
- TCP logging tools for OS must be installed as explained in CAIA-TR-150210C.pdf;
- Traffic generators must be installed as explained in CAIA-TR-150210C.pdf;
- Support tools must be installed as explained in CAIA-TR-150210C.pdf, but
  depending on the OS many of these are already installed by default.

A multi-boot OS setup with PXE booting and power controllers as decribed in
CAIA-TR-150210C.pdf is very useful but optional.


DOCUMENTATION
-----------

Running experiments: For more details on how to setup experiments and
the design of TEACUP please refer to ./docs/TEACUP-System-v1.1.pdf
or https://sourceforge.net/projects/teacup/files/TEACUP-System-v1.1.pdf

Analysing experiments: For more details on how to analyse the data collected
during experiments please refer to ./docs/TEACUP-Analysis-v1.1.pdf or
https://sourceforge.net/projects/teacup/files/TEACUP-Analysis-v1.1.pdf

A command reference doc is at ./docs/TEACUP-Commandref-v1.1.pdf or
https://sourceforge.net/projects/teacup/files/TEACUP-Commandref-v1.1.pdf


COPYRIGHT
---------

- Any 3rd party software tools provided under ./tools are covered by
the specific copyright and license terms contained within each tool's
tarball. It is our current belief that these tools allow redistribution
in this manner.

- All remaining files (including those under ./example_configs) are
covered by ./COPYING and ./ACKNOWLEDGEMENTS.