At the end of the project it is expected that the students will
make a practical demonstration, will turn in their properly
commented code, a hardcopy final
report hardcopy, and everything produced during this project as a
The organization of the final project report should resemble a
research paper that has an experimental component. There is a 10 page
at 10 pt font with a 1 inch margins page limit; however, if you
really need more space, you can have more.
The report should have the following sections (notice depending on
your particular project one or more sections may not fit, and you may
have other sections to add):
- Abstract - 150 - 400 words, self contained paragraph that
summarizes the report. It should answer "What?" "Why?" and
"How?" you did what you did.
- Introduction Introduction to the problem of
interest. What is the problem? Why is the problem
important? What are possible applications? Very briefly
what is your contribution.
- Related work Present briefly (one paragraph/paper) what
others did in the areas related to your work. It should
show me that you did not do your project without having
any idea on what happens elsewhere. The more
comprehensive, the better. Finish the section with
- Problem formulation, or Model, Explain how you're going
to attack the problem, and what are the steps to solve
it. Explain what are you going to do in the in the next
section and why. What are the expected results.
- Experimental results In this section present the results of
your experiments. Please do not dump an inordinate amount
of data. It is an art to present the data in such a way
to yield maximum insight into a phenomenon. Do not expect
that the reader will read through three pages of data to
notice an interesting phenomenon. Most of the time graphs
are preferred to tables. Remember that the report should
be self contained, do not make references to the ./data
- Analysis In this section you should analyze the
experimental results from the previous section. All
features (absolute values, relative values, variations,
irregularities, minimums, etc.) should be explained. You
should be confident in the explanations, and have the data
to back-up your confidence. "Maybe", "probably" and
"perhaps" should not be in this section. In some cases it
is easier (and better) to blend this section with the
previous section. This section will be your main
contribution to the project, and most of the final grade
will come out of this section.
- Conclusion Summarize the problem, solution and your findings,
pointing to anything out of the ordinary.
- Appendices Include here anything that is not essential to the flow
of your report (e.g. theorem proofs, supplementary
experimental data, implementation considerations, etc.)
Turn in a softcopy of "everything", organized as described below:
Create a directory named "Teamn", where n is your team number
In this directory place the following:
- "index.html" - a html document that gives a user easy
access to all files in the Team folder. Make sure
all links are relative. All files should be
accessible using this html file (link to a directory
for access at the files is OK). The idea is to be easy
for me to post the project results, and for the
students next year to browse through your
projects. Please include the title of the project, the
name of the team members and their email addresses.
- "finalReport.pdf" - pdf version of the final report
(see below for what should contain). Also include the original
source file (.doc, or .tex + figures, etc).
- "problemDescription.html" - copy of the original problem description
as on the original web-page of the project web-site.
- "practicalProblems.html" - A comprehensive (as comprehensive as
possible) list of problems that you encountered and the
solutions, including the dead-ends. How-to manuals, links to
how-to manuals, miracle flags and advice for next year's students.
- "software.html" - links to *all* software that you used to complete
the project (compilers, drivers, patches, iperf,
libpcap, etc.). Also, all the settings needed for
somebody to replicate your experimental setup
(e.g. linux familiar version x.y.z, gcc version w,
- "hardware.html" - list of all hardware used in the experiment,
including their manufacturer.
After everything is in place (files and directories), please tar and
gzip the directory and uploaded in Wolfware (as any other online
- ./src - source code if you wrote any for this project
- Make sure the source code is well commented
(points will be deducted if it's not).
- Include a README.txt which will briefly explain
what is in each of the source files
- Include a Makefile that will make all executables
(also install and clean if appropriate).
- ./bin - executables,
include a README.txt to identify which executable does what
- ./doc - manuals for the programs you wrote (installation,
command line parameters, user guides, etc.)
- Data measurements,
- scripts to process the measurements and make the graphs in
the report (e.g. Matlab, or excel sheets).
- README.txt to help a reader make sense of which measurement