Engineering Computing Report Guidelines

Go to following link for general information on engineering reports:

http://evan.lemley.org/courses/engr_report_format_spring_2005.pdf


There may be some variation in the above format for software projects:

Intro
What is the basic problem and what were the objectives of what you did.

Background or Problem Description
This is basics of what you are modeling - in this case it's radiation transport
through a material.  You can reference the project announcement on this.

Methodology or Problem Solution
How did you solve the problem.  What is basic flow of the program (i.e. a
flowchart), A sample program that implements your solution - (this is best
listed in an Appendix).  Any limitations of the solution should be listed here.

Results
Demo and Test Case results - verification that the functions or procedure you
have developed works properly.  A demo case just shows how it works.  Test cases
(you need at least two) really put your software to the test.  You should have
one test case where bad input is given and the ability of the code to detect
this and respond appropriately is shown.

Summary and Conclusions
Short and to the point

References
See the link above to make sure you are referencing materials properly.  The
project handout should be a web reference.